Docs¶
proxmox docs --help¶
Input:
Output:
Usage: proxmox docs [OPTIONS] COMMAND [ARGS]...
Generate CLI documentation artifacts for MkDocs.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────╮
│ generate-capture Capture proxmox CLI command input/output recursively from │
│ the command tree. │
╰──────────────────────────────────────────────────────────────────────────────╯
Exit code: 0 · Wall time (s): 0.215
proxmox docs generate-capture --help¶
Input:
Output:
Usage: proxmox docs generate-capture [OPTIONS]
Capture proxmox CLI command input/output recursively from the command tree.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --output -o PATH Markdown output path (default: │
│ <repo>/docs/generated/proxmox-command-capture… │
│ --raw-dir PATH JSON artifact directory (default: │
│ <repo>/docs/generated/raw). │
│ --max-lines INTEGER Max lines per output block in the generated │
│ Markdown. │
│ [default: 200] │
│ --max-chars INTEGER Max characters per output block in the │
│ generated Markdown. │
│ [default: 120000] │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Exit code: 0 · Wall time (s): 0.235