CLI reference / space / work-root

stado space work-root

Invocation

stado space work-root [OPTIONS] <TARGET>

Purpose

Read or declare where TARGET's agent keeps the fleet's work: job trees, build caches, published free space. With no `--path` this prints the declaration in force. With `--path` it creates the directory on the host owned by the agent's account, refuses a path on the root volume, and writes `targets[].work_root` through the canonical registry's compare-and-swap. The agent uses the new root once its unit restarts it.

Required inputs and options

Input or optionContract
<TARGET>Positional input; required or optional as shown in the invocation.
--path <PATH>An absolute directory on the target's selected mounted data volume
--jsonCommand option; required or optional as shown in the invocation.

Output and state effect

This is an inspection/reporting operation. It emits the result described above and does not change managed state unless an explicit option in this page says otherwise. Pass `--json` when the command exposes that machine-readable option.

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.