Command CLI Options

Commands can also have their own CLI options.

In fact, each command can have different CLI arguments and CLI options:

Python 3.7+Python 3.7+ non-Annotated

import typer
from typing_extensions import Annotated

app = typer.Typer()


@app.command()
def create(username: str):
    print(f"Creating user: {username}")


@app.command()
def delete(
    username: str,
    force: Annotated[
        bool, typer.Option(prompt="Are you sure you want to delete the user?")
    ],
):
    if force:
        print(f"Deleting user: {username}")
    else:
        print("Operation cancelled")


@app.command()
def delete_all(
    force: Annotated[
        bool, typer.Option(prompt="Are you sure you want to delete ALL users?")
    ],
):
    if force:
        print("Deleting all users")
    else:
        print("Operation cancelled")


@app.command()
def init():
    print("Initializing user database")


if __name__ == "__main__":
    app()

Tip

Prefer to use the Annotated version if possible.

import typer

app = typer.Typer()


@app.command()
def create(username: str):
    print(f"Creating user: {username}")


@app.command()
def delete(
    username: str,
    force: bool = typer.Option(..., prompt="Are you sure you want to delete the user?"),
):
    if force:
        print(f"Deleting user: {username}")
    else:
        print("Operation cancelled")


@app.command()
def delete_all(
    force: bool = typer.Option(
        ..., prompt="Are you sure you want to delete ALL users?"
    ),
):
    if force:
        print("Deleting all users")
    else:
        print("Operation cancelled")


@app.command()
def init():
    print("Initializing user database")


if __name__ == "__main__":
    app()

Here we have multiple commands, with different CLI parameters:

• create:
  • username: a CLI argument.
• delete:
  • username: a CLI argument.
  • --force: a CLI option, if not provided, it's prompted.
• delete-all:
  • --force: a CLI option, if not provided, it's prompted.
• init:
  • Doesn't take any CLI parameters.

fast →💬 Check the helppython main.py --help

Usage: main.py [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:
  create
  delete
  delete-all
  info

restart ↻

Tip

Check the command delete-all, by default command names are generated from the function name, replacing _ with -.

Test it:

fast →💬 Check the command createpython main.py create Camila
Creating user: Camila

💬 Now test the command deletepython main.py delete Camila
y
Deleting user: Camila

python main.py delete Wade
n
Operation cancelled

💬 And finally, the command delete-all💬 Notice it doesn't have CLI arguments, only a CLI option
python main.py delete-all
y
Deleting all users

python main.py delete-all
n
Operation cancelled

💬 And if you pass the --force CLI option, it doesn't need to confirm
python main.py delete-all --force
Deleting all users

💬 And init that doesn't take any CLI parameterpython main.py init
Initializing user database

restart ↻