Skip to content

Proxbox CLI Docgen

proxbox_cli now ships a small documentation-generation pipeline modeled after the one in netbox-cli.

What It Generates

The generator writes three artifact sets under docs/generated/:

  • proxbox-cli-command-capture.md: combined raw snapshot of representative command captures
  • proxbox-cli/raw/*.json: one JSON artifact per captured command plus index.json
  • proxbox-cli/catalog.json: recursively generated inventory of the CLI command tree

MkDocs then uses docs/hooks.py to render those raw artifacts into:

  • docs/reference/proxbox-cli/command-examples/
  • docs/reference/proxbox-cli/command-catalog/

Capture Strategy

The current capture set is intentionally safe and reproducible:

  • it runs python -m proxbox_cli ... from the local repository checkout
  • it captures --help output for representative command groups and commands
  • it generates example invocations automatically by walking the Typer/Click command tree

That means the documentation can be rebuilt without depending on a live proxbox-api instance.

Regenerate

From the repository root:

python docs/generate_proxbox_cli_docs.py

Or through the installed CLI entrypoint:

pxb docs generate-capture

Then rebuild the docs site:

uv run --with-requirements requirements-docs.txt mkdocs build