runbooks / command
List runbooks
Lists runbooks, filtered or by what a diff affects. If you're a terminal lover, forget about the UI. This command prints each runbook's status and last run as a table, right in the chat.
❯ /runbooks:list [--failed] [--active] [--draft] [--outdated] [--blocked] [--placeholder] [--capability x] [--feature y] [--tag t] [--status s] [--path glob] [--role r] [--review] [--affected [base]] [--model <model>]❯ $runbooks:runbooks-list [--failed] [--active] [--draft] [--outdated] [--blocked] [--placeholder] [--capability x] [--feature y] [--tag t] [--status s] [--path glob] [--role r] [--review] [--affected [base]] [--model <model>]Parameters
Every filter is optional. The state flags add up: a runbook is listed when it matches any of them, once. The other filters narrow that list: a runbook must match all of them. Without any filter, every runbook is listed.
| Parameter | What it does |
|---|---|
--failed |
Runbooks whose last run failed (last_run.result: failed). |
--blocked |
Runbooks whose last run was blocked (last_run.result: blocked). |
--outdated |
Runbooks whose last run is outdated (last_run.outdated: true). |
--active |
Runbooks with status active. |
--draft |
Runbooks with status draft. |
--placeholder |
Runbooks with status placeholder. |
--capability <x> |
Runbooks of one capability (the folder under paths.runbooks). |
--feature <y> |
Runbooks whose feature frontmatter is y. |
--tag <t> |
Runbooks tagged t. critical marks the ones to run first. |
--status <s> |
placeholder, draft, active or deprecated. |
--path <glob> |
Runbooks that cover an entry whose file matches the glob. |
--role <r> |
With role tracking on: runbooks whose roles include the role. roles: all counts for every registered role. See roles. |
--review |
With role tracking on: runbooks with a review entry, whose text may be wrong after a role change. /runbooks:update clears each one. |
--affected [base] |
Runbooks the changes since base reach: committed, uncommitted and untracked files. base defaults to git.base. Leaves out deprecated runbooks and placeholders. Only changes in this repository count. A change in an upstream API in another repository counts when it arrives as a new version of upstream.schema: a runbook whose calls name a changed, added or removed operation is listed with the reason upstream schema: <METHOD /path> changed. See another repository. |
--model <m> |
Run this invocation on one model: inline (in the main session), haiku, sonnet, opus or fable. Any value but inline runs the command in a sub-agent on that model. Without it, the command takes its row of the models table in the config: by default list runs inline. On Codex, the values are inline, inherit (a sub-agent on the session's model) or a model ID the session supports, and the table is codex.models, where every row that is not inline defaults to inherit. See models. |
/runbooks:list # every runbook
/runbooks:list --failed # last run failed
/runbooks:list --blocked --outdated # last run blocked or outdated
/runbooks:list --active --failed # active or failed, each once
/runbooks:list --draft --placeholder # not yet passed a full run
/runbooks:list --capability billing # one capability
/runbooks:list --feature invoices # one feature
/runbooks:list --tag critical # the ones to run first
/runbooks:list --status placeholder # flows with no runbook yet
/runbooks:list --status draft # not yet passed a full run
/runbooks:list --status active # passed a full run
/runbooks:list --status deprecated # retired
/runbooks:list --path 'src/app/billing/**' # cover files under a path
/runbooks:list --role editor # the runbooks editor runs
/runbooks:list --review # waiting for role lines after a role change
/runbooks:list --affected # touched since git.base
/runbooks:list --affected origin/main # touched since origin/main
/runbooks:list --capability billing --tag critical # filters combine
/runbooks:list --model sonnet # in a sonnet sub-agent