Skip to main content
Version: v5.6.1

opschain settings edit

Included from Basic tier

opschain settings edit <node-path> -f <doc.json|yaml> [--base-version N]

Replaces a server node's stored settings data with the -f file's document, which becomes the new version wholesale — a replace, not a merge, so fetch the current data with opschain settings show first, edit it, and submit the whole document. The file is a JSON or YAML object. Server-only: pass --server <url> or select a context with opschain context use.

The write is versioned compare-and-set, exactly as opschain properties edit (see opschain docs cli/properties-edit): the current version is read and PATCHed against, so a concurrent edit surfaces the server's named version-mismatch error instead of being clobbered; --base-version skips the read and asserts your edit's base version instead. On success it prints updated settings of <node-path>: version N → M.

Flags​

FlagMeaning
-f, --file <file>The document's new data, a JSON or YAML object (required; replaces the stored data wholesale).
--base-version NThe version the edit was made against (skips the read; a stale value surfaces the server's version-mismatch error).

Exit codes​

CodeMeaning
0New version written.
1Version mismatch, missing node/document, authorisation, or the request failed.
2Usage error.

Named errors​

  • -f is required — the file holds the document's new data (exit 2).
  • <path>: the settings data must be a JSON or YAML object: <cause> (exit 2).
  • 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.
  • A lost compare-and-set race surfaces the named conflict — the document changed while you edited it (your edit was based on version N; the server now holds version M) — re-run the edit (exit 1).
  • The node settings runner block edited here supplies default placement for the node's runs — resolution and the verdict ladder: opschain docs fleet-queue.

See also​

  • opschain docs cli/settings-show — fetch the current data to edit.
  • opschain docs cli/settings-history — the version trail every edit appends to.
  • opschain learn 1.3 — properties and settings, guided.