← Schema index / Config Reference
actions schema
Canonical generated docsThis section is generated from
caco config schema --json. The table below preserves the runtime field path, type, required/default markers, and canonical description for every value in this slice.Top-level operator-defined runnable commands. Keyed by action name.
| Field path | Type | Required | Default | Canonical description |
|---|---|---|---|---|
actions | section | optional | Top-level operator-defined runnable commands. Keyed by action name. | |
└ actions.<action-name> | map | optional | Named action entry. | |
└ actions.<action-name>.type | string | required | Action type (currently only 'command'). | |
└ actions.<action-name>.command | string | required | Shell command to execute. | |
└ actions.<action-name>.description | string | optional | Human-readable description. | |
└ actions.<action-name>.roles_permitted | list[string] | optional | Roles/profiles allowed to invoke (e.g. 'operator', 'profile:<name>'). | |
└ actions.<action-name>.cwd | string | optional | Working directory for command execution. | |
└ actions.<action-name>.timeout_secs | u64 | optional | 300 | Timeout in seconds for command execution. |
└ actions.<action-name>.idempotent | bool | optional | false | Whether exact replay is safe after restart. |
└ actions.<action-name>.check | string | optional | Side-effect-free shell command that exercises the action's prerequisites; run by 'caco action check'. |