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
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
1 maintainer
Metadata
1 maintainer
Release files for typer-helptree 0.2.12
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| typer_helptree-0.2.12.tar.gz | 12.5 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| typer_helptree-0.2.12-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 26.9 kB
Release files / typer_helptree-0.2.12.tar.gz
| Download URL | typer_helptree-0.2.12.tar.gz |
|---|---|
| Size | 12.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
2677bd412f6c1a0481ccc1912a2e7968c57a1f8221801804bb4ac4de24b5c519
|
|
BLAKE2b-256 checksum How to use checksums |
a0708a9e2da648f6a63d5ea140520557d9895e07b3246922322ce16e877e678c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Aug 4, 2026.
Transparency logRelease files / typer_helptree-0.2.12-py3-none-any.whl
| Download URL | typer_helptree-0.2.12-py3-none-any.whl |
|---|---|
| Size | 14.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
b328673474234c4c60994a34e52091e1eb530efb533294cd916f0f4d88e5cd59
|
|
BLAKE2b-256 checksum How to use checksums |
29019c1452db9fa5504945cbce123dbd5f9e01ea10f6c7379210794df15eed3a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Aug 4, 2026.
Transparency log
