Command reference
stax plan-install
Preview rendered install actions without writing files
Generate a machine-readable plan from the same rendering pipeline used by stax materialize, but do not write anything to disk. This is useful for CI, review workflows, and platform integrations that need to inspect what would be written.
Usage
stax plan-install ghcr.io/myorg/agents/backend-engineer:3.1.0 --consumer codex
stax plan-install ghcr.io/myorg/agents/backend-engineer:3.1.0 --consumer codex --json
stax plan-install ./artifact-dir --consumer claude-code --exactOptions
| Flag | Description |
|---|---|
--consumer <id> | Target runtime / adapter |
--json | Emit machine-readable JSON |
--exact | Require a non-lossy plan when supported |
Plan contents
The current reference CLI returns:
| Field | Description |
|---|---|
selectedAdapter | Adapter chosen for rendering |
fidelity | Render fidelity (byte-exact, schema-exact, best-effort) |
lossy | Whether warnings or fidelity imply information loss |
actions | mkdir and write actions derived from rendered files |
warnings | Adapter and compatibility warnings |
When --json is used, the CLI also includes a lightweight compatibility summary.
Example output
Install plan for ghcr.io/myorg/agents/backend-engineer:3.1.0
adapter: codex
fidelity: best-effort
lossy: false
Actions:
[mkdir] .agents/skills/
[write] AGENTS.md
[write] .codex/config.tomlRelated commands
stax materialize— Render and write the filesstax inspect— View artifact metadata without rendering