CLI Reference

Use nbx <command> --help for the exact options supported by your installed version.

Core workflow

Command	Purpose
nbx analyze [path]	Build or refresh the local structural model.
nbx search "<query>"	Retrieve task-relevant workflows and definitions.
nbx def <name-or-uid>	Inspect one symbol with callers and dependencies.
nbx query "<cypher>"	Run a read-only graph query.
nbx map	Show communities and execution workflows.
nbx diff	Compare working-tree structure with the analyzed baseline.
nbx verify --digest	Summarize structural verification findings.

nbx analyze .
nbx search "auth refresh flow"
nbx def refreshToken

Setup and targeting

Command	Purpose
nbx init [path]	Create box configuration.
nbx repo <subcommand>	Manage repositories inside a box.
nbx list	List local boxes.
nbx status	Inspect freshness and integrity.
nbx configure	Configure supported coding agents.
nbx auth	Manage authentication.

Read commands use the current box by default. Common target controls are:

• --box <ID|PATH|NAME> — use another local box.
• --repo <ALIAS> — select one repository in the box.
• --hub <REF> — explicitly read an external Hub target.

Maintenance

Command	Purpose
nbx update	Update the CLI.
nbx migrate --dry-run	Preview metadata migration.
nbx doctor	Diagnose installation and local state.
nbx cache	Inspect or manage caches.
nbx delete	Delete a selected box.
nbx reset	Reset Noodlbox-managed state.
nbx feedback	Prepare a support report.
nbx version	Print the installed version.

delete, reset, migration, and configuration commands can change managed state. Read their command help before automation.

Output

• --json requests machine-readable output where supported.
• -h, --help prints command help.
• -V, --version prints the CLI version.

Next

• Configuration
• Troubleshooting