Top-level¶
nbx --help¶
Usage: root [OPTIONS] COMMAND [ARGS]...
NetBox API-first CLI/TUI. Dynamic command form: nbx <group> <resource>
<action>
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────╮
│ init │
│ config │
│ groups │
│ resources │
│ ops │
│ call │
│ tui │
│ docs Generate reference documentation (captured CLI │
│ input/output). │
│ demo NetBox demo.netbox.dev profile and command tree. │
│ circuits OpenAPI app group: circuits │
│ core OpenAPI app group: core │
│ dcim OpenAPI app group: dcim │
│ extras OpenAPI app group: extras │
│ ipam OpenAPI app group: ipam │
│ plugins OpenAPI app group: plugins │
│ tenancy OpenAPI app group: tenancy │
│ users OpenAPI app group: users │
│ virtualization OpenAPI app group: virtualization │
│ vpn OpenAPI app group: vpn │
│ wireless OpenAPI app group: wireless │
╰──────────────────────────────────────────────────────────────────────────────╯
exit 0 1.357s
nbx init --help¶
Usage: root init [OPTIONS]
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ * --base-url TEXT NetBox base URL, e.g. │
│ https://netbox.example.com │
│ [required] │
│ * --token-key TEXT NetBox API token key [required] │
│ * --token-secret TEXT NetBox API token secret [required] │
│ --timeout FLOAT HTTP timeout in seconds [default: 30.0] │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
exit 0 1.290s
nbx config --help¶
exit 1 1.287s
nbx groups --help¶
exit 1 1.381s
nbx resources --help¶
Usage: root resources [OPTIONS] GROUP
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * group TEXT OpenAPI app group, e.g. dcim [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
exit 1 1.307s
nbx ops --help¶
Usage: root ops [OPTIONS] GROUP RESOURCE
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * group TEXT [required] │
│ * resource TEXT [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
exit 1 1.322s
nbx call --help¶
Usage: root call [OPTIONS] METHOD PATH
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * method TEXT [required] │
│ * path TEXT [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --query -q TEXT Query parameter key=value │
│ --body-json TEXT Inline JSON request body │
│ --body-file TEXT Path to JSON request body file │
│ --json Output raw JSON │
│ --yaml Output YAML │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
exit 1 1.319s
nbx tui --help¶
Usage: root tui [OPTIONS]
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --theme Theme selector. Use '--theme' to list available themes or │
│ '--theme <name>' to launch with one. │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
exit 0 1.305s
nbx tui --theme¶
exit 0 1.305s
nbx docs --help¶
Usage: root docs [OPTIONS] COMMAND [ARGS]...
Generate reference documentation (captured CLI input/output).
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────╮
│ generate-capture Capture every nbx command (input + output) and write │
│ docs/generated/nbx-command-capture.md. │
╰──────────────────────────────────────────────────────────────────────────────╯
exit 0 1.353s
nbx docs generate-capture --help¶
Usage: root docs generate-capture [OPTIONS]
Capture every nbx command (input + output) and write
docs/generated/nbx-command-capture.md.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --output -o PATH Markdown destination. Default: │
│ <repo>/docs/generated/nbx-command-capture.md │
│ --raw-dir PATH Raw JSON artifacts directory. Default: │
│ <repo>/docs/generated/raw/ │
│ --max-lines INTEGER Max lines per command output in the Markdown. │
│ [default: 200] │
│ --max-chars INTEGER Max chars per command output in the Markdown. │
│ [default: 120000] │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
exit 0 1.313s