Skip to content

Configuration

Most projects need no manual configuration:

Terminal window
nbx analyze .
nbx configure

nbx init creates explicit box configuration when defaults are not enough:

Terminal window
nbx init --name my-box --alias app

Use nbx repo to manage multiple repositories inside one box:

Terminal window
nbx repo add ./apps/api --as api
nbx repo add ./apps/web --as web
nbx repo list

Repository aliases must be unique. Changing an alias changes repository identity and requires re-analysis.

nbx configure detects and configures supported coding clients:

Terminal window
nbx configure
nbx configure status

Use nbx configure --force to replace outdated managed assets. Avoid editing generated files by hand.

  • nbx init --ci requires existing box configuration and lock state.
  • nbx status --check exits non-zero when analysis is stale or integrity checks fail.
  • nbx configure -y accepts integration defaults without prompts.
  • nbx verify --digest --audience agent produces a concise verification report.

Local reads use the current box. Use --box, --repo, or --hub explicitly when another target is intended.

Hub synchronization is opt-in:

Terminal window
nbx sync enable
nbx sync disable

Review and commit changes to .nbx/nbx.toml when synchronization intent changes.

Preview metadata migrations before applying them:

Terminal window
nbx migrate --dry-run