typer-helptree 0.2.10.4

Display your entire CLI structure, beautifully. Screenshot ready.

typer-helptree

The helptree command can be added to your Typer CLI.

User story

• Dev: "I want to a screenshot of my CLI structure, to add to my GitHub release and to my README."

typer-helptree helptree

How To

Use helptree in your Typer CLI:

# src/yourtyperapp/cli.py

# --- External Imports ---
import typer
from rich.console import Console
# Import the add_typer_helptree command.
from typer_helptree.helptree import add_typer_helptree

# --- Internal Imports ---
from ._version import __version__ # or however you do this.

# --- Typical Typer App Instantiation ---
APP_NAME "yourtyperapp"
console = Console()
app = typer.Typer(
    name=APP_NAME
)

# --- The Magic ---

add_typer_helptree(app=app, console=console, version = __version__, hidden=True)

And then, from the command line:

yourtyperapp helptree

To export an SVG and JSON to the ~/.typer_helptree dir:

yourtyperapp helptree --export-svg --export-json

---

Projects that use typer-helptree

• https://pypi.org/project/pdflinkcheck/
• https://pypi.org/project/dworshak/