Typer Cheatsheet Command

A pluggable cheatsheet command for your Typer applications to visualize their command tree structure.

This library provides a cheatsheet subcommand that you can easily integrate into any existing Typer application. It automatically inspects your Typer application and its subcommands/groups to generate a clear, tree-like representation, making it easier for users to understand available commands.

It traverses the command tree generated by Typer and can also emit a versioned JSON description with command parameters for agents and tooling.

Installation

You can install this library directly from GitHub using uv

uv add git+https://github.com/mgaitan/typer-cheatsheet-command.git

Demo

You can run the demo application included in this repository to see the cheatsheet command in action:

uvx typer-cheatsheet-command cheatsheet

This will output a tree structure of the demo (dummy) application's commands:

Integrating into your Typer application

To add the cheatsheet command to your own Typer application, simply import the register_cheatsheet_command function and call it with your typer.Typer instance.

First, ensure typer-cheatsheet-command is installed in your project's environment.

Then, in your main application file (e.g., main.py):

# main.py
import typer
from typer_cheatsheet_command.cheatsheet_command import register_cheatsheet_command

app = typer.Typer(name="MyCoolApp", help="A cool command-line application.")


@app.command()
def hello(name: str = "World"):
    """Say hello to someone."""
    print(f"Hello {name}!")


users_app = typer.Typer(help="Manage users.")


@users_app.command("create")
def create_user(username: str):
    """Creates a new user."""
    print(f"Creating user {username}")


app.add_typer(users_app, name="users")

# Register the cheatsheet command
register_cheatsheet_command(app)

if __name__ == "__main__":
    app()

Now, when you run your application, the cheatsheet command will be available:

uv run main.py cheatsheet

This would produce an output similar to:

╭─ Cheatsheet ───────────────────────────────────────────────────────────────╮
│ MyCoolApp                                                                  │
│ ├── hello: Say hello to someone.                                           │
│ ├── cheatsheet: Show the command tree structure of the application.        │
│ └── users: Manage users.                                                   │
│     └── create: Creates a new user.                                        │
╰────────────────────────────────────────────────────────────────────────────╯

By default, the command is registered as cheatsheet. If you want to use a different name for the subcommand, you can set it explicitly

register_cheatsheet_command(app, command_name="cheat")

The command description is configurable and may contain multiple lines:

register_cheatsheet_command(
    app,
    description="""Show every available command.

    Includes nested groups and their parameters.
    """,
)

JSON output

Use JSON when another program needs to discover commands, options, arguments, and nested groups:

uv run main.py cheatsheet --output json

Hidden commands are excluded by default. Pass --show-all to include them in either output format.

The same data is available from Python without registering a command:

from typer_cheatsheet_command import get_command_tree

command_tree = get_command_tree(app)