nookins / docs
Command line

nookins config

Arguments and options for nookins config and its subcommands.

Documentation for Nookins 0.42.1-alpha.1 · Public alpha

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.

nookins config

Inspect or change Nookins configuration revisions

Usage: nookins config [OPTIONS] <COMMAND>

Commands:
  migrate    Explicitly convert a schema-8 through schema-18 bundle into schema 19
  status     Show canonical, active, snapshot, and running-process config drift
  diff       Preview semantic changes against the active revision without staging
  explain    Explain the effective value and ordered source chain for one JSON pointer
  apply      Validate, stage, activate, persist, and restart when required
  rollback   Reactivate an existing revision and restart a managed service when required
  validate
  revisions
  export
  help       Print this message or the help of the given subcommand(s)

Options:
      --output <OUTPUT>  Select stable human output or the versioned machine envelope [default: human] [possible values: human, json]
  -h, --help             Print help

nookins config migrate

Explicitly convert a schema-8 through schema-18 bundle into schema 19

Usage: nookins config migrate [OPTIONS] [PATH]

Arguments:
  [PATH]  Pre-schema-19 config bundle entrypoint; defaults to --config/NOOKINS_CONFIG

Options:
      --write              Atomically rewrite the local source bundle while Nookins is stopped. This is the bootstrap bridge for a breaking schema deployment
      --restore <RESTORE>  Restore one protected predecessor bundle by migration ID
      --no-restart         Leave a restart-required revision pending instead of restarting a managed service
      --output <OUTPUT>    Select stable human output or the versioned machine envelope [default: human] [possible values: human, json]
  -h, --help               Print help

nookins config status

Show canonical, active, snapshot, and running-process config drift

Usage: nookins config status [OPTIONS]

Options:
      --output <OUTPUT>  Select stable human output or the versioned machine envelope [default: human] [possible values: human, json]
  -h, --help             Print help

nookins config diff

Preview semantic changes against the active revision without staging

Usage: nookins config diff [OPTIONS] [PATH]

Arguments:
  [PATH]  Candidate config; defaults to the global --config/NOOKINS_CONFIG path

Options:
      --output <OUTPUT>  Select stable human output or the versioned machine envelope [default: human] [possible values: human, json]
  -h, --help             Print help

nookins config explain

Explain the effective value and ordered source chain for one JSON pointer

Usage: nookins config explain [OPTIONS] <POINTER> [PATH]

Arguments:
  <POINTER>  RFC 6901 path such as /workspace/quotas/workspace_size
  [PATH]     Config bundle entrypoint; defaults to the global --config/NOOKINS_CONFIG path

Options:
      --output <OUTPUT>  Select stable human output or the versioned machine envelope [default: human] [possible values: human, json]
  -h, --help             Print help

nookins config apply

Validate, stage, activate, persist, and restart when required

Usage: nookins config apply [OPTIONS] [PATH]

Arguments:
  [PATH]  Candidate config; defaults to the global --config/NOOKINS_CONFIG path

Options:
      --dry-run
      --offline          Apply directly while Nookins is stopped, without the control plane
      --no-restart       Leave a restart-required revision pending instead of restarting a managed service
      --output <OUTPUT>  Select stable human output or the versioned machine envelope [default: human] [possible values: human, json]
  -h, --help             Print help

nookins config rollback

Reactivate an existing revision and restart a managed service when required

Usage: nookins config rollback [OPTIONS] [ID]

Arguments:
  [ID]  Revision to restore; defaults to the newest revision before the active one

Options:
      --no-restart       Leave a restart-required revision pending instead of restarting a managed service
      --output <OUTPUT>  Select stable human output or the versioned machine envelope [default: human] [possible values: human, json]
  -h, --help             Print help

nookins config validate

Usage: nookins config validate [OPTIONS] [PATH]

Arguments:
  [PATH]  Config to validate; defaults to the global --config/NOOKINS_CONFIG path

Options:
      --output <OUTPUT>  Select stable human output or the versioned machine envelope [default: human] [possible values: human, json]
  -h, --help             Print help

nookins config revisions

Usage: nookins config revisions [OPTIONS]

Options:
      --output <OUTPUT>  Select stable human output or the versioned machine envelope [default: human] [possible values: human, json]
  -h, --help             Print help

nookins config export

Usage: nookins config export [OPTIONS]

Options:
      --revision <REVISION>
      --view <VIEW>            [default: sanitized] [possible values: exact, sanitized]
      --file <DESTINATION>     Write the YAML export to a file instead of stdout
      --directory <DIRECTORY>  Atomically materialize the versioned source bundle into a new directory
      --output <OUTPUT>        Select stable human output or the versioned machine envelope [default: human] [possible values: human, json]
  -h, --help                   Print help

On this page