CLI reference / registry / set

stado registry set

Invocation

stado registry set [OPTIONS] --path <PATH> --value <VALUE>

Purpose

Change one field of the canonical registry, under the generation it was read at. The path is the one `pull --path` reads, so a field a caller can read it can write: `registry set --path targets.<host>.release_platform --value darwin-arm64`. The value is JSON when it parses as JSON and the literal text when it does not. A last field the object does not carry yet is created (`--path targets.<host>.privacy_grants --value '[...]'`), and the whole document must still pass the validation `push` runs, so a malformed value of a field the registry validates is refused; a path whose holder does not exist is refused, naming the keys or element names that do. Setting an array is how one of its entries is added, changed or removed. A registry that moved since the read is refused with exit 75, as `push --if-generation` is.

Required inputs and options

Input or optionContract
--path <PATH>Command option; required or optional as shown in the invocation.
--value <VALUE>Command option; required or optional as shown in the invocation.
--jsonEmit a `stado.registry-set-receipt.v1` object instead of the sentence

Output and state effect

It performs the operation described above and emits its operator result on standard output or standard error. Any state change is limited to the resources and records named by the purpose and options on this page.

Refusals

  • Before dispatch, Stado refuses a missing required token shown in the invocation, an unknown option, or a value outside a listed value set; argument-usage failures exit with code 2.