Plan CLI reference
List a Workspace's plans, and retire or restore one.
Use this page to read what atoi plan answers and the flags it takes. The terminal reads and retires plans over the same read and write the chat agent uses, so a plan retired here leaves the list the agent reads too.
atoi planList a Workspace’s plans, and retire or restore one, over the same read and write chat uses.
| Command | What it does |
|---|---|
atoi plan list | List the plans in the Workspace the terminal is standing in, with their ids, status and checklist progress. |
atoi plan archive | Retire one plan. It leaves the list and comes back with restore. A plan in another Workspace is refused, not touched. |
atoi plan restore | Bring a retired plan back. |
#plan list
List the plans in the Workspace the terminal is standing in, with their ids, status and checklist progress.
atoi plan list [--project <project-id>] [--workspace <id>] [--personal] [--archived] [--limit <n>]
| Flag | Type | Default | Values | What it does |
|---|---|---|---|---|
--project | string | Select a Project by id. | ||
--workspace | string | Answer one Workspace by id for this call; without it, the Workspace the terminal is standing in. | ||
--personal | boolean | Answer Personal for this call, whatever the terminal is standing in. | ||
--archived | boolean | Include retired plans. | ||
--limit | number | Limit the number of returned records. | ||
--json | boolean | false | Emit the canonical JSON envelope. | |
--ndjson | boolean | false | Emit one canonical JSON envelope per line. | |
--format | string | text | text, json | Choose human text or the JSON envelope. |
--help -h | boolean | Show command help. |
#Run plan list
atoi plan list --json{
"tool": "atoi_plan",
"arguments": {
"action": "list"
}
}Without --workspace, the list answers for the Workspace the terminal is standing in; --personal steps out to Personal for one call. Retired plans stay out of the list unless you pass --archived.
#plan archive
Retire one plan. It leaves the list and comes back with restore.
atoi plan archive <plan-id> [--workspace <id>] [--personal]
| Flag | Type | Default | Values | What it does |
|---|---|---|---|---|
--workspace | string | Answer one Workspace by id for this call; without it, the Workspace the terminal is standing in. | ||
--personal | boolean | Answer Personal for this call, whatever the terminal is standing in. | ||
--json | boolean | false | Emit the canonical JSON envelope. | |
--ndjson | boolean | false | Emit one canonical JSON envelope per line. | |
--format | string | text | text, json | Choose human text or the JSON envelope. |
--help -h | boolean | Show command help. |
#Run plan archive
atoi plan archive pln_3k8d --json{
"tool": "atoi_plan",
"arguments": {
"action": "archive",
"plan_id": "pln_3k8d"
}
}A plan in another Workspace is refused, not touched. Stand in its Workspace with
atoi workspace use, or pass--workspacefor the one call.
#plan restore
Bring a retired plan back.
atoi plan restore <plan-id> [--workspace <id>] [--personal]
| Flag | Type | Default | Values | What it does |
|---|---|---|---|---|
--workspace | string | Answer one Workspace by id for this call; without it, the Workspace the terminal is standing in. | ||
--personal | boolean | Answer Personal for this call, whatever the terminal is standing in. | ||
--json | boolean | false | Emit the canonical JSON envelope. | |
--ndjson | boolean | false | Emit one canonical JSON envelope per line. | |
--format | string | text | text, json | Choose human text or the JSON envelope. |
--help -h | boolean | Show command help. |
#Run plan restore
atoi plan restore pln_3k8d --jsonRead Run work from the terminal for the rest of this group, or the CLI reference index for every command.
Was this useful?