nookins / docs
Command line

nookins maintenance

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

Back up, verify, release, index, and manage Nookins assets

Usage: nookins maintenance [OPTIONS] <COMMAND>

Commands:
  consolidate   Move completed installer/update files into this home and reclaim verified bootstrap copies. Stop Nookins first; rerun to resume an interruption
  housekeeping  Inspect or reclaim managed deployments and backups
  database
  backup
  release
  assets
  index
  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 maintenance consolidate

Move completed installer/update files into this home and reclaim verified bootstrap copies. Stop Nookins first; rerun to resume an interruption

Usage: nookins maintenance consolidate [OPTIONS]

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

nookins maintenance housekeeping

Inspect or reclaim managed deployments and backups

Usage: nookins maintenance housekeeping [OPTIONS] <COMMAND>

Commands:
  preview          Show recovery protection and reclaimable allocated bytes without deleting anything
  apply            Recompute eligibility and reclaim expired managed artifacts under the maintenance lock
  hold             Protect an exact verified backup or immutable generation
  release-hold     Release an explicit retention hold
  classify-backup  Enroll a backup in automatic retention or mark it manual
  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 maintenance housekeeping preview

Show recovery protection and reclaimable allocated bytes without deleting anything

Usage: nookins maintenance housekeeping preview [OPTIONS]

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

nookins maintenance housekeeping apply

Recompute eligibility and reclaim expired managed artifacts under the maintenance lock

Usage: nookins maintenance housekeeping apply [OPTIONS]

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

nookins maintenance housekeeping hold

Protect an exact verified backup or immutable generation

Usage: nookins maintenance housekeeping hold [OPTIONS] --reason <REASON> <KIND> <NAME>

Arguments:
  <KIND>  [possible values: backup, generation]
  <NAME>

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

nookins maintenance housekeeping release-hold

Release an explicit retention hold

Usage: nookins maintenance housekeeping release-hold [OPTIONS] <KIND> <NAME>

Arguments:
  <KIND>  [possible values: backup, generation]
  <NAME>

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

nookins maintenance housekeeping classify-backup

Enroll a backup in automatic retention or mark it manual

Usage: nookins maintenance housekeeping classify-backup [OPTIONS] <NAME> <CLASS>

Arguments:
  <NAME>
  <CLASS>  [possible values: automatic, manual]

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

nookins maintenance database

Usage: nookins maintenance database [OPTIONS] <COMMAND>

Commands:
  compact                   Create a verified compact copy and atomically replace a stopped Core database
  migrate-legacy-schedules  Bind legacy role-only schedules to the local primary owner and their existing destinations
  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 maintenance database compact

Create a verified compact copy and atomically replace a stopped Core database

Usage: nookins maintenance database compact [OPTIONS] --backup <BACKUP> --confirm <CONFIRM>

Options:
      --backup <BACKUP>    Mandatory verified backup archive written before the swap
      --confirm <CONFIRM>  Explicit acknowledgement of stopped-service and disk-space requirements
      --output <OUTPUT>    Select stable human output or the versioned machine envelope [default: human] [possible values: human, json]
  -h, --help               Print help

nookins maintenance database migrate-legacy-schedules

Bind legacy role-only schedules to the local primary owner and their existing destinations

Usage: nookins maintenance database migrate-legacy-schedules [OPTIONS] --confirm <CONFIRM>

Options:
      --backup <BACKUP>
          Mandatory verified backup written before any schedule grant changes
      --verified-backup <VERIFIED_BACKUP>
          Reuse an existing verified pre-migration backup when retrying a failed atomic attempt
      --confirm <CONFIRM>
          Exact acknowledgement of the authority change and stopped-service requirement
      --output <OUTPUT>
          Select stable human output or the versioned machine envelope [default: human] [possible values: human, json]
  -h, --help
          Print help

nookins maintenance backup

Usage: nookins maintenance backup [OPTIONS] <COMMAND>

Commands:
  create         Back up durable home data; includes secrets
  verify         Verify archive structure and every declared content digest
  restore        Restore atomically into a destination which must not already exist
  retention      Report exact backup archives, size, age, verification, and release provenance
  prune-preview  Preview explicitly named archives from the managed backup catalog
  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 maintenance backup create

Back up durable home data; includes secrets

Usage: nookins maintenance backup create [OPTIONS] <ARCHIVE>

Arguments:
  <ARCHIVE>

Options:
      --automatic                 Enroll this managed-directory backup in daily/weekly automatic retention
      --include-assets            Include large, re-downloadable managed assets and model files
      --include-semantic-indexes  Include only verified active/retired disposable semantic files. Core remains sufficient to rebuild them when omitted
      --output <OUTPUT>           Select stable human output or the versioned machine envelope [default: human] [possible values: human, json]
  -h, --help                      Print help

nookins maintenance backup verify

Verify archive structure and every declared content digest

Usage: nookins maintenance backup verify [OPTIONS] <ARCHIVE>

Arguments:
  <ARCHIVE>

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

nookins maintenance backup restore

Restore atomically into a destination which must not already exist

Usage: nookins maintenance backup restore [OPTIONS] <ARCHIVE>

Arguments:
  <ARCHIVE>

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

nookins maintenance backup retention

Report exact backup archives, size, age, verification, and release provenance

Usage: nookins maintenance backup retention [OPTIONS]

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

nookins maintenance backup prune-preview

Preview explicitly named archives from the managed backup catalog

Usage: nookins maintenance backup prune-preview [OPTIONS] <ARCHIVE>...

Arguments:
  <ARCHIVE>...  Exact archive file name(s) shown by `nookins maintenance backup retention`

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

nookins maintenance release

Usage: nookins maintenance release [OPTIONS] <COMMAND>

Commands:
  install-authenticated-local  Install an authenticated local archive using an already provisioned trust store (Linux only)
  recover-authenticated-local  Reauthenticate and resume an owned local archive operation (Linux only)
  install-authenticated-https  Download and install a signed HTTPS release using an explicitly provisioned trust store
  recover-authenticated-https  Reauthenticate over HTTPS and resume the same owned installation operation
  bootstrap-source             Bootstrap this executing source binary into an absent or complete admitted home
  manifest                     Print the provenance manifest embedded in this exact Nookins binary
  verify                       Verify the active managed binary against its adjacent release manifest
  verify-generation            Verify an unpacked immutable generation with the runtime activation verifier
  install-generation           Enroll an absent home and install this executing verifier's qualified generation
  recover-install              Resume the matching fresh installation without ordinary runtime admission
  stage-generation             Verify, fsync, seal, and expose one generation below this Nookins home
  activate-generation          Activate one already-staged immutable generation through the managed rollback engine
  retention                    Report active, rollback-protected, held, and prune-eligible managed versions
  hold                         Place an attributed, optionally expiring hold on one exact managed version
  release-hold                 Release the retention hold on one exact managed version
  prune-preview                Preview exact eligible managed-version directories without deleting them
  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 maintenance release install-authenticated-local

Install an authenticated local archive using an already provisioned trust store (Linux only)

Usage: nookins maintenance release install-authenticated-local [OPTIONS] --trust-store <TRUST_STORE> --metadata <METADATA> --targets <TARGETS> --operation <OPERATION> --version <VERSION> --channel <CHANNEL>

Options:
      --trust-store <TRUST_STORE>
      --metadata <METADATA>
      --targets <TARGETS>
      --operation <OPERATION>
      --version <VERSION>
      --channel <CHANNEL>          [possible values: alpha, beta, stable]
      --output <OUTPUT>            Select stable human output or the versioned machine envelope [default: human] [possible values: human, json]
  -h, --help                       Print help

nookins maintenance release recover-authenticated-local

Reauthenticate and resume an owned local archive operation (Linux only)

Usage: nookins maintenance release recover-authenticated-local [OPTIONS] --trust-store <TRUST_STORE> --metadata <METADATA> --targets <TARGETS> --operation <OPERATION> --version <VERSION> --channel <CHANNEL>

Options:
      --trust-store <TRUST_STORE>
      --metadata <METADATA>
      --targets <TARGETS>
      --operation <OPERATION>
      --version <VERSION>
      --channel <CHANNEL>          [possible values: alpha, beta, stable]
      --output <OUTPUT>            Select stable human output or the versioned machine envelope [default: human] [possible values: human, json]
  -h, --help                       Print help

nookins maintenance release install-authenticated-https

Download and install a signed HTTPS release using an explicitly provisioned trust store

Usage: nookins maintenance release install-authenticated-https [OPTIONS] --trust-store <TRUST_STORE> --metadata <METADATA> --targets <TARGETS> --operation <OPERATION> --version <VERSION> --channel <CHANNEL>

Options:
      --trust-store <TRUST_STORE>
      --archive <ARCHIVE>          Reuse a local archive only after fresh HTTPS metadata authenticates its exact bytes
      --metadata <METADATA>        HTTPS metadata base URL from the explicitly configured repository
      --targets <TARGETS>          HTTPS targets base URL on the same origin
      --operation <OPERATION>
      --output <OUTPUT>            Select stable human output or the versioned machine envelope [default: human] [possible values: human, json]
      --version <VERSION>
      --channel <CHANNEL>          [possible values: alpha, beta, stable]
  -h, --help                       Print help

nookins maintenance release recover-authenticated-https

Reauthenticate over HTTPS and resume the same owned installation operation

Usage: nookins maintenance release recover-authenticated-https [OPTIONS] --trust-store <TRUST_STORE> --metadata <METADATA> --targets <TARGETS> --operation <OPERATION> --version <VERSION> --channel <CHANNEL>

Options:
      --trust-store <TRUST_STORE>
      --archive <ARCHIVE>          Reuse a local archive only after fresh HTTPS metadata authenticates its exact bytes
      --metadata <METADATA>        HTTPS metadata base URL from the explicitly configured repository
      --targets <TARGETS>          HTTPS targets base URL on the same origin
      --operation <OPERATION>
      --output <OUTPUT>            Select stable human output or the versioned machine envelope [default: human] [possible values: human, json]
      --version <VERSION>
      --channel <CHANNEL>          [possible values: alpha, beta, stable]
  -h, --help                       Print help

nookins maintenance release bootstrap-source

Bootstrap this executing source binary into an absent or complete admitted home

Usage: nookins maintenance release bootstrap-source [OPTIONS]

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

nookins maintenance release manifest

Print the provenance manifest embedded in this exact Nookins binary

Usage: nookins maintenance release manifest [OPTIONS]

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

nookins maintenance release verify

Verify the active managed binary against its adjacent release manifest

Usage: nookins maintenance release verify [OPTIONS]

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

nookins maintenance release verify-generation

Verify an unpacked immutable generation with the runtime activation verifier

Usage: nookins maintenance release verify-generation [OPTIONS] --manifest-sha256 <MANIFEST_SHA256> <ROOT>

Arguments:
  <ROOT>

Options:
      --manifest-sha256 <MANIFEST_SHA256>

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

nookins maintenance release install-generation

Enroll an absent home and install this executing verifier's qualified generation

Usage: nookins maintenance release install-generation [OPTIONS] --manifest-sha256 <MANIFEST_SHA256> <ROOT>

Arguments:
  <ROOT>

Options:
      --manifest-sha256 <MANIFEST_SHA256>

      --parent-lineage <PARENT_LINEAGE>
          Correlate a parent-owned installation; does not grant installation authority
      --output <OUTPUT>
          Select stable human output or the versioned machine envelope [default: human] [possible values: human, json]
  -h, --help
          Print help

nookins maintenance release recover-install

Resume the matching fresh installation without ordinary runtime admission

Usage: nookins maintenance release recover-install [OPTIONS] --manifest-sha256 <MANIFEST_SHA256> <ROOT>

Arguments:
  <ROOT>

Options:
      --manifest-sha256 <MANIFEST_SHA256>

      --parent-lineage <PARENT_LINEAGE>
          Correlate a parent-owned installation; does not grant installation authority
      --output <OUTPUT>
          Select stable human output or the versioned machine envelope [default: human] [possible values: human, json]
  -h, --help
          Print help

nookins maintenance release stage-generation

Verify, fsync, seal, and expose one generation below this Nookins home

Usage: nookins maintenance release stage-generation [OPTIONS] --manifest-sha256 <MANIFEST_SHA256> <ROOT>

Arguments:
  <ROOT>

Options:
      --manifest-sha256 <MANIFEST_SHA256>

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

nookins maintenance release activate-generation

Activate one already-staged immutable generation through the managed rollback engine

Usage: nookins maintenance release activate-generation [OPTIONS] --manifest-sha256 <MANIFEST_SHA256> <GENERATION_ID>

Arguments:
  <GENERATION_ID>

Options:
      --manifest-sha256 <MANIFEST_SHA256>

      --migration-binding-sha256 <MIGRATION_BINDING_SHA256>

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

nookins maintenance release retention

Report active, rollback-protected, held, and prune-eligible managed versions

Usage: nookins maintenance release retention [OPTIONS]

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

nookins maintenance release hold

Place an attributed, optionally expiring hold on one exact managed version

Usage: nookins maintenance release hold [OPTIONS] --reason <REASON> <VERSION>

Arguments:
  <VERSION>

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

nookins maintenance release release-hold

Release the retention hold on one exact managed version

Usage: nookins maintenance release release-hold [OPTIONS] <VERSION>

Arguments:
  <VERSION>

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

nookins maintenance release prune-preview

Preview exact eligible managed-version directories without deleting them

Usage: nookins maintenance release prune-preview [OPTIONS] <VERSION>...

Arguments:
  <VERSION>...

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

nookins maintenance assets

Usage: nookins maintenance assets [OPTIONS] <COMMAND>

Commands:
  status
  list
  verify     Verify downloaded artifacts and installed runtime resources
  reconcile  Install, repair, and update resources using their owning version policy
  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 maintenance assets status

Usage: nookins maintenance assets 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 maintenance assets list

Usage: nookins maintenance assets list [OPTIONS]

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

nookins maintenance assets verify

Verify downloaded artifacts and installed runtime resources

Usage: nookins maintenance assets verify [OPTIONS] [NAME]

Arguments:
  [NAME]

Options:
      --all              Select every resource supported on this platform, including optional models
      --output <OUTPUT>  Select stable human output or the versioned machine envelope [default: human] [possible values: human, json]
  -h, --help             Print help

nookins maintenance assets reconcile

Install, repair, and update resources using their owning version policy

Usage: nookins maintenance assets reconcile [OPTIONS] [NAME]

Arguments:
  [NAME]

Options:
      --all              Select every resource supported on this platform, including optional models
      --output <OUTPUT>  Select stable human output or the versioned machine envelope [default: human] [possible values: human, json]
  -h, --help             Print help

nookins maintenance index

Usage: nookins maintenance index [OPTIONS] <COMMAND>

Commands:
  status
  rebuild
  verify
  gc
  compact-core
  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 maintenance index status

Usage: nookins maintenance index status [OPTIONS]

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

nookins maintenance index rebuild

Usage: nookins maintenance index rebuild [OPTIONS] --agent <AGENT>

Options:
      --agent <AGENT>    Agent whose disposable semantic index should be rebuilt
      --output <OUTPUT>  Select stable human output or the versioned machine envelope [default: human] [possible values: human, json]
  -h, --help             Print help

nookins maintenance index verify

Usage: nookins maintenance index verify [OPTIONS] --agent <AGENT>

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

nookins maintenance index gc

Usage: nookins maintenance index gc [OPTIONS]

Options:
      --execute          Actually delete the exact eligible generation files. Without this flag the command is a dry run
      --output <OUTPUT>  Select stable human output or the versioned machine envelope [default: human] [possible values: human, json]
  -h, --help             Print help

nookins maintenance index compact-core

Usage: nookins maintenance index compact-core [OPTIONS] --backup <BACKUP> --confirm <CONFIRM>

Options:
      --backup <BACKUP>    Mandatory verified backup created before legacy table removal
      --confirm <CONFIRM>  Exact destructive-operation acknowledgement
      --output <OUTPUT>    Select stable human output or the versioned machine envelope [default: human] [possible values: human, json]
  -h, --help               Print help

On this page

nookins maintenancenookins maintenance consolidatenookins maintenance housekeepingnookins maintenance housekeeping previewnookins maintenance housekeeping applynookins maintenance housekeeping holdnookins maintenance housekeeping release-holdnookins maintenance housekeeping classify-backupnookins maintenance databasenookins maintenance database compactnookins maintenance database migrate-legacy-schedulesnookins maintenance backupnookins maintenance backup createnookins maintenance backup verifynookins maintenance backup restorenookins maintenance backup retentionnookins maintenance backup prune-previewnookins maintenance releasenookins maintenance release install-authenticated-localnookins maintenance release recover-authenticated-localnookins maintenance release install-authenticated-httpsnookins maintenance release recover-authenticated-httpsnookins maintenance release bootstrap-sourcenookins maintenance release manifestnookins maintenance release verifynookins maintenance release verify-generationnookins maintenance release install-generationnookins maintenance release recover-installnookins maintenance release stage-generationnookins maintenance release activate-generationnookins maintenance release retentionnookins maintenance release holdnookins maintenance release release-holdnookins maintenance release prune-previewnookins maintenance assetsnookins maintenance assets statusnookins maintenance assets listnookins maintenance assets verifynookins maintenance assets reconcilenookins maintenance indexnookins maintenance index statusnookins maintenance index rebuildnookins maintenance index verifynookins maintenance index gcnookins maintenance index compact-core