NAME¶

nbox - Terminal UI and CLI for NetBox

SYNOPSIS¶

nbox [-p|--profile] [--config] [--json] [-o|--output] [--fields] [--raw] [--envelope] [--no-tui] [--log-level] [--log-file] [-h|--help] [-V|--version] [subcommands]

DESCRIPTION¶

Terminal UI and CLI for NetBox

OPTIONS¶

-p, --profile <PROFILE>

Configuration profile to use (overrides the active profile)

--config <CONFIG>

Path to an alternate config file

--json

Emit machine-readable JSON instead of human output

-o, --output <FORMAT>

Output format: plain (default), json, or csv. `--json` is a shortcut

Possible values:

--fields <FIELDS>

JSON only: keep only these top-level fields (comma-separated)

--raw

JSON only: compact output instead of pretty-printed

--envelope

JSON only: wrap output as `{schema_version, data}`

--no-tui

Never launch the interactive TUI

--log-level <LOG_LEVEL>

Logging level (e.g. `info`, `debug`, `nbox=debug`)

--log-file <PATH>

Write logs to this file instead of (only) stderr. stdout stays clean

-h, --help

Print help (see a summary with '-h')

-V, --version

Print version

SUBCOMMANDS¶

nbox-tui(1)

Launch the interactive TUI

nbox-search(1)

Search devices, sites, racks, rack groups, IPs, prefixes, VLANs, circuits, virtual circuits, aggregates, ASNs, IP ranges, tenants, contacts, providers, VMs, VM types, clusters, VRFs, and route targets

nbox-device(1)

Show a device by name, slug, or ID

nbox-ip(1)

Look up an IP address, or reserve the next one in a prefix

nbox-prefix(1)

Show prefix details and children, or reserve a child prefix

nbox-next-ip(1)

Show the next available IP address(es) in a prefix

nbox-next-prefix(1)

Show available (free) prefix(es) within a prefix

nbox-site(1)

Show a site

nbox-rack(1)

Show a rack

nbox-rack-group(1)

Show a rack group by slug, name, or numeric ID

nbox-circuit(1)

Show a circuit by CID or numeric ID

nbox-provider(1)

Show a provider by slug, name, or numeric ID

nbox-virtual-circuit(1)

Show a virtual circuit by CID or numeric ID (NetBox 4.2+)

nbox-aggregate(1)

Show an aggregate by CIDR or numeric ID

nbox-asn(1)

Show an ASN by number

nbox-ip-range(1)

Show an IP range by start address or numeric ID

nbox-tenant(1)

Show a tenant by slug, name, or numeric ID

nbox-contact(1)

Show a contact by name or numeric ID

nbox-vm(1)

Show a virtual machine by name or numeric ID

nbox-vm-type(1)

Show a virtual machine type by slug, name, or numeric ID (NetBox 4.6+)

nbox-cluster(1)

Show a cluster by name or numeric ID

nbox-vrf(1)

Show a VRF by name, route distinguisher (RD), or numeric ID

nbox-route-target(1)

Show a route target (e.g. 65000:100) and the VRFs that import/export it

nbox-mac(1)

Show a MAC address — reverse-resolve it to the interface(s)/device(s) that carry it (NetBox 4.2+)

nbox-vlan(1)

Show a VLAN by VID or name

nbox-interface(1)

Show an interface on a device, or set a writable field (a write — see `set`)

nbox-open(1)

Open a NetBox object in the browser

nbox-tags(1)

List tags

nbox-tagged(1)

List objects carrying a tag (NetBox 4.3+ `/api/extras/tagged-objects/`). A cross-kind reverse lookup: "what has tag X" in one call — unlike `search --tag`, which needs a `q` and filters per endpoint. The tag is resolved by id, exact name, or exact slug

nbox-tag(1)

Add or remove a tag on an object (a write — ADR-0001 safe-write foundation). `nbox tag add <type> <name> <tag>` / `nbox tag remove <type> <name> <tag>` resolve the object and the tag, then send a minimal `PATCH` to update the tags array. Behind `--allow-writes` + confirmation. A no-op (tag already present/absent) sends no `PATCH`

nbox-journal(1)

Show recent journal entries for an object

nbox-history(1)

Show the change history (audit log) for an object — what changed, when, and by whom. Distinct from `journal` (operator notes): this is the system-recorded create/update/delete log from NetBox's `/api/core/ object-changes/` (NetBox 4.x)

nbox-raw(1)

Make a raw read-only API request (escape hatch for unmodeled endpoints)

nbox-status(1)

Show NetBox connection, versions, backend capabilities, and a token-validity preflight (NetBox 4.5+)

nbox-config(1)

Manage configuration

nbox-profile(1)

Manage profiles

nbox-completions(1)

Generate shell completions

nbox-man(1)

Generate man pages (roff) for nbox

nbox-serve(1)

Run the MCP server for AI agents / MCP clients (read-only by default; `--allow-writes` enables the opt-in write tools)

nbox-export(1)

Structured read-only exports (e.g. Prometheus service-discovery JSON). Query NetBox via the read engine and emit a fixed structured shape to stdout — distinct from the presentation-oriented JSON/CSV view layer

nbox-help(1)

Print this message or the help of the given subcommand(s)

VERSION¶

v0.14.0