Demo Profile¶
nbx demo --help¶
Usage: nbx demo [OPTIONS] COMMAND [ARGS]...
NetBox demo.netbox.dev profile and command tree.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --token-key TEXT Set the demo profile directly without │
│ Playwright. │
│ --token-secret TEXT Set the demo profile directly without │
│ Playwright. │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────╮
│ init Authenticate with demo.netbox.dev via Playwright and save │
│ the demo profile. │
│ config Show the configured demo profile settings. │
│ test Test connectivity to demo.netbox.dev using the configured │
│ demo profile. │
│ reset Remove the saved demo profile configuration. │
│ tui Launch the TUI against the demo profile. │
│ cli CLI builder tools against the demo.netbox.dev profile. │
│ dev Developer-focused tools against the demo.netbox.dev profile. │
│ 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 3.428s
nbx demo init --help¶
Usage: nbx demo init [OPTIONS]
Authenticate with demo.netbox.dev via Playwright and save the demo profile.
Pass ``--username`` and ``--password`` for non-interactive / CI use.
Alternatively, supply an existing token directly with ``--token-key`` and
``--token-secret`` to skip Playwright entirely.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --headless --headed Run Playwright headless (default). Use │
│ --headed only when a desktop/X server │
│ is available. │
│ [default: headless] │
│ --username -u TEXT demo.netbox.dev username. Prompted │
│ interactively when omitted. │
│ --password -p TEXT demo.netbox.dev password. Prompted │
│ interactively when omitted. │
│ --token-key TEXT Set the demo profile directly without │
│ Playwright (requires --token-secret). │
│ --token-secret TEXT Set the demo profile directly without │
│ Playwright (requires --token-key). │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
exit 0 3.421s
nbx demo config --help¶
Usage: nbx demo config [OPTIONS]
Show the configured demo profile settings.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --show-token Include API token in output │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
exit 0 3.477s
nbx demo test --help¶
Usage: nbx demo test [OPTIONS]
Test connectivity to demo.netbox.dev using the configured demo profile.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
exit 0 3.415s
nbx demo reset --help¶
exit 0 3.432s
nbx demo dev --help¶
Usage: nbx demo dev [OPTIONS] COMMAND [ARGS]...
Developer-focused tools against the demo.netbox.dev profile.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────╮
│ tui Launch the developer request workbench TUI against the demo │
│ profile. │
│ http Direct HTTP operations mapped from OpenAPI paths (nbx dev │
│ http <method> --path ...). │
│ django-model Inspect NetBox Django models: parse, cache, and visualize │
│ relationships. │
│ django-models Inspect NetBox Django models: parse, cache, and visualize │
│ relationships. │
╰──────────────────────────────────────────────────────────────────────────────╯
exit 0 4.016s
nbx demo cli --help¶
Usage: nbx demo cli [OPTIONS] COMMAND [ARGS]...
CLI builder tools against the demo.netbox.dev profile.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────╮
│ tui Launch the interactive CLI command builder against the demo profile. │
╰──────────────────────────────────────────────────────────────────────────────╯
exit 0 3.512s
nbx demo dev django-model --help¶
Usage: nbx demo dev django-model [OPTIONS] COMMAND [ARGS]...
Inspect NetBox Django models: parse, cache, and visualize relationships.
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────╮
│ build Parse NetBox Django models and build the static cache. │
│ tui Launch the Django Model Inspector TUI. │
│ fetch Fetch a NetBox release from GitHub and build the Django model graph. │
╰──────────────────────────────────────────────────────────────────────────────╯
exit 0 3.390s
nbx demo config¶
exit 0 3.358s