Command-line reference

Captured from nookins 0.42.1-alpha.1 using help only. Angle-bracket names are required values; square brackets indicate optional input. Substitute your own IDs and paths.

Select the right home

Put root options before the command: nookins --home /path/to/home --url http://127.0.0.1:8790 service status. The global --output human|json selects the output format; it does not grant access. Keep tokens out of command history and support reports. Nookins reads its private secrets file; do not source it into your shell.

An authored listen value wins over the fallback flag/environment value. A nondefault server port also requires a matching control URL. Read the command's help for required values and available preview/recovery flags. A help entry is not evidence that an optional runtime, provider, account or platform is configured.

Root options and command groups

Nookins multi-agent messaging runtime and administration CLI

Usage: nookins [OPTIONS] <COMMAND>

Commands:
  onboard      Resume Nookins’ guided onboarding and optionally start the supervised stack
  update       Check or install a signed update using saved settings
  console      Open the owner console for local conversation and administration
  service      Start, stop, inspect, install, or supervise Nookins
  doctor       Run system and surface diagnostics
  config       Inspect or change Nookins configuration revisions
  events       Discover Nookins’ typed public event contracts
  automations  Validate and dry-run configured event automations
  channel      Authenticate and diagnose messaging channels
  agent        Inspect agent history and the Nookins-owned Codex login
  workspace    Inspect and reconcile durable per-agent filesystem workspaces
  operations   Inspect or operate queues, schedules, approvals, sessions, and usage
  maintenance  Back up, verify, release, index, and manage Nookins assets
  extension    Discover, create, validate, and inspect extension packages
  feature      Inspect Nookins’ compiled, directly configured built-in features
  capability   Inspect installed capability readiness and setup requirements
  sentinel     Inspect or probe the durable Sentinel ambient runtime
  browser      Manage Nookins-owned persistent browser profiles
  migrate      Inspect and migrate supported state from another agent runtime
  help         Print this message or the help of the given subcommand(s)

Options:
      --home <HOME>      [env: NOOKINS_HOME=~/.nookins] [default: ~/.nookins]
      --url <URL>        [env: NOOKINS_URL=] [default: http://127.0.0.1:8790]
      --token <TOKEN>    [env: NOOKINS_ADMIN_TOKEN]
      --config <CONFIG>  [env: NOOKINS_CONFIG=] [default: ~/.nookins/config/nookins.yaml]
      --listen <LISTEN>  Fallback listen address when nookins.yaml omits listen; an authored value wins [env: NOOKINS_LISTEN=]
      --output <OUTPUT>  Select stable human output or the versioned machine envelope [default: human] [possible values: human, json]
  -h, --help             Print help
  -V, --version          Print version

Browse commands

Safe operating sequence

Use configuration validation and preview before changes, backup and recovery before destructive maintenance, and diagnostics when a command fails. Commands that authenticate, install, apply, start, restore, cancel or send can change state. A failed command is not proof that no external effect occurred; preserve its operation ID and follow its recovery instructions. Do not retry ambiguous external actions blindly.

The hidden supervisor/process interface is deliberately excluded. help is the standard help dispatcher: nookins help COMMAND or nookins COMMAND --help.

Select the right home

Root options and command groups

Browse commands

Safe operating sequence

On this page