Skip to main content
Version: v5.7.0

opschain settings show

Included from Basic tier

opschain settings show <node-path> [--version N]

Shows a server node's stored settings document — the current version, or with --version N one version from its history. The node path is the usual positional form (demo, demo/environments/dev, demo/environments/dev/assets/web, an entity such as demo/entities/rack_1, or a full /projects/... path). The current version reads over the API v2 by-path document read (SettingsService.GetSettings); a --version read stays on the v1 versions endpoint, which has no v2 twin yet. Server-only: pass --server <url> or select a context with opschain context use.

Identical mechanics to opschain properties show — see opschain docs cli/properties-show for the output walkthrough. The plain output prints path, id, version, created_at and the pretty-printed data; -o json / -o yaml print the same fields as a document.

Flags​

FlagMeaning
--version NShow this version from the document's history instead of the current one.

Exit codes​

CodeMeaning
0Shown.
1The node or version does not exist, the node has no stored document, or the request failed.
2Usage error.

Named errors​

  • stored settings documents live on a server's nodes — pass --server <url> or 'opschain context use <name>' (exit 2).
  • <node-path> has no stored settings document on this server.

See also​

  • opschain docs cli/settings-history, opschain docs cli/settings-edit.
  • opschain learn 1.3 — properties and settings, guided.