Command reference

scout is the only operator command surface. Use scout <command> --help for flags and typed inputs, and --json when consuming evidence in automation.

Runtime and contexts

scout doctor --artifact-root <release-root>
scout init --state-dir <state-dir> --artifact-root <release-root>
scout start --state-dir <state-dir>
scout stop --state-dir <state-dir>
scout status
scout tree --descendants
scout dashboard --state-dir <state-dir>
scout context ls
scout context use <name>
scout login

Runtime state is bounded by the selected local state directory. Contexts hold Controller location and caller-owned authentication; credentials are never recipe parameters.

Shipped recipes

scout run --list
scout run bootstrap-network NAME=VALUE...
scout run add-branch NAME=VALUE...
scout run connect-client NAME=VALUE...
scout run share-path NAME=VALUE...
scout run --resume

A recipe executes plan → step → evidence → resume. One CLI-local file retains the interrupted run; Scout stores no recipe-run record on a server. See the recipe reference for every required parameter and the evidence each step must verify before it advances.

Command families

The following table includes the API-mapped operator surface and the CLI-composed Router commands:

Area	Commands
Branches	branch add, branch ls, branch show, branch quarantine, activate, status, tree
Clients	client add, client auth, client ls, client show, client renew, client revoke
Data Areas	area add, area ls, area show
Grants	grant allow, grant deny, grant enable, grant disable, grant remove, grant ls, grant show, grant explain, grant ceiling
Changes	change new, change review, change stage, change apply, change cancel, change rollback, change history
Tokens	token ls, token show, token revoke
Routers	router restart, router logs, router diag

Mechanism endpoints explicitly marked waived in the parity map support the dashboard or a composed command and are not standalone CLI verbs. The parity check fails if an operation becomes orphaned or an unmapped command is inferred.

router restart <branch-id> and router logs <branch-id> [--tail <1-1000>] are shipped grammar, but the current API has no restart operation or log stream. They return unavailable without restarting anything or substituting a local log file. router diag <branch-id> returns only the Controller’s current evidence and does not infer unavailable fields.

Services

scout service install --state-dir <state-dir>
sudo scout service install --state-dir <state-dir> --enable
scout service status --state-dir <state-dir>
scout service disable --state-dir <state-dir>

Manager mutations require explicit system-administrator authority. Without --enable, installation only stages the rendered service definitions.