nookins / docs
Command line

nookins service

Arguments and options for nookins service 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 service

Start, stop, inspect, install, or supervise Nookins

Usage: nookins service [OPTIONS] <COMMAND>

Commands:
  foreground  Run the complete supervised stack in the foreground
  install     Atomically install, enable, and start the systemd user service
  start       Start the installed service and wait for every Nookins role to become ready
  stop        Stop the service and its complete process cgroup
  restart     Restart the service and wait for every Nookins role to become ready
  retry-role  Immediately retry one exact degraded supervised role
  status      Show service-manager ownership and Nookins role readiness
  memory      Show total resident memory and the contribution from each supervised role
  uninstall   Stop, disable, and remove the systemd user service
  logs        Read Nookins supervisor logs from the user journal
  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 service foreground

Run the complete supervised stack in the foreground

Usage: nookins service foreground [OPTIONS]

Options:
      --database <DATABASE>
          [env: NOOKINS_DB=] [default: ~/.nookins/state/nookins.db]
      --transport-token <TRANSPORT_TOKEN>
          [env: NOOKINS_TRANSPORT_TOKEN] [default: ""]
      --database-key <DATABASE_KEY>
          [env: NOOKINS_DB_KEY]
      --allow-plaintext-development
          [env: NOOKINS_ALLOW_PLAINTEXT_DEV=]
      --no-runners

      --output <OUTPUT>
          Select stable human output or the versioned machine envelope [default: human] [possible values: human, json]
      --runtime-uid <RUNTIME_UID>
          [env: NOOKINS_RUNTIME_UID=]
      --codex-home <CODEX_HOME>
          [env: NOOKINS_CODEX_HOME=] [default: ~/.nookins/state/codex]
      --no-worker

      --no-transport

  -h, --help
          Print help

nookins service install

Atomically install, enable, and start the systemd user service

Usage: nookins service install [OPTIONS]

Options:
      --force                Back up and replace a different existing Nookins user unit
      --no-start             Install and enable the unit without starting it now
      --allow-dirty-release  Permit a visibly labeled dirty/unknown development build
      --output <OUTPUT>      Select stable human output or the versioned machine envelope [default: human] [possible values: human, json]
  -h, --help                 Print help

nookins service start

Start the installed service and wait for every Nookins role to become ready

Usage: nookins service start [OPTIONS]

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

nookins service stop

Stop the service and its complete process cgroup

Usage: nookins service stop [OPTIONS]

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

nookins service restart

Restart the service and wait for every Nookins role to become ready

Usage: nookins service restart [OPTIONS]

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

nookins service retry-role

Immediately retry one exact degraded supervised role

Usage: nookins service retry-role [OPTIONS] <ROLE>

Arguments:
  <ROLE>

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

nookins service status

Show service-manager ownership and Nookins role readiness

Usage: nookins service 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 service memory

Show total resident memory and the contribution from each supervised role

Usage: nookins service memory [OPTIONS]

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

nookins service uninstall

Stop, disable, and remove the systemd user service

Usage: nookins service uninstall [OPTIONS]

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

nookins service logs

Read Nookins supervisor logs from the user journal

Usage: nookins service logs [OPTIONS]

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

On this page