Skip to content

mkdocs-typer2

A sample CLI

Usage:

console $ mkdocs-typer2 [OPTIONS] COMMAND [ARGS]...

Options:

  • --install-completion: Install completion for the current shell.
  • --show-completion: Show completion for the current shell, to copy it or customize the installation.
  • --help: Show this message and exit.

Commands:

  • docs: Generate docs for a project
  • hello: Some docstring content

mkdocs-typer2 docs

Generate docs for a project

Usage:

console $ mkdocs-typer2 docs [OPTIONS]

Options:

  • --name TEXT: The name of the project [required]
  • --help: Show this message and exit.

mkdocs-typer2 hello

Some docstring content

Usage:

console $ mkdocs-typer2 hello [OPTIONS] NAME

Arguments:

  • NAME: The name of the person to greet [required]

Options:

  • --caps / --no-caps: Whether to capitalize the name [default: no-caps]
  • --color TEXT: The color of the output
  • --help: Show this message and exit.