typer-helptree

The helptree command can be added to your Typer CLI.

User story

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

typer-helptree helptree

Screenshot of the 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

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

typer_helptree-0.2.12.tar.gz (12.5 kB view details)

Uploaded Aug 4, 2026 Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

typer_helptree-0.2.12-py3-none-any.whl (14.4 kB view details)

Uploaded Aug 4, 2026 Python 3

File details

Details for the file typer_helptree-0.2.12.tar.gz.

File metadata

Download URL: typer_helptree-0.2.12.tar.gz
Upload date: Aug 4, 2026
Size: 12.5 kB
Tags: Source
Uploaded using Trusted Publishing? Yes
Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for typer_helptree-0.2.12.tar.gz
Algorithm	Hash digest
SHA256	`2677bd412f6c1a0481ccc1912a2e7968c57a1f8221801804bb4ac4de24b5c519`
MD5	`4f59324e192c1a4c564ebaba73a6196c`
BLAKE2b-256	`a0708a9e2da648f6a63d5ea140520557d9895e07b3246922322ce16e877e678c`

See more details on using hashes here.

Provenance

The following attestation bundles were made for typer_helptree-0.2.12.tar.gz:

Publisher: publish.yml on City-of-Memphis-Wastewater/typer-helptree

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Statement:
- Statement type: https://in-toto.io/Statement/v1
- Predicate type: https://docs.pypi.org/attestations/publish/v1
- Subject name: typer_helptree-0.2.12.tar.gz
- Subject digest: 2677bd412f6c1a0481ccc1912a2e7968c57a1f8221801804bb4ac4de24b5c519
- Sigstore transparency entry: 2341689453
- Sigstore integration time: Aug 4, 2026
Source repository:
- Permalink: City-of-Memphis-Wastewater/typer-helptree@0a4f889abeccb86f0990d12a80191a08b1ea1c75
- Branch / Tag: refs/tags/v0.2.12
- Owner: https://github.com/City-of-Memphis-Wastewater
- Access: public
Publication detail:
- Token Issuer: https://token.actions.githubusercontent.com
- Runner Environment: github-hosted
- Publication workflow: publish.yml@0a4f889abeccb86f0990d12a80191a08b1ea1c75
- Trigger Event: release