Skip to content
DevelopersTerminal

Task CLI reference


Start, inspect, continue, cancel, apply, and publish proof-bearing Tasks.

On this page

Use this page to inspect every public atoi task command, its accepted flags, and one runnable example. Return to the CLI reference index to choose another command group.

atoi taskStart, inspect, continue, cancel, apply, and publish proof-bearing Tasks.

CommandWhat it does
atoi task listList Tasks, optionally within one Project.
atoi task startStart durable implementation work in a Project.
atoi task getRead Task state, result, changes, checks, asks, and proof.
atoi task changesInspect the materialized, proof-linked Task change set.
atoi task applyApply a verified change set to the matching local repository.
atoi task draft-prPublish a verified change set to a proof-backed draft pull request.
atoi task waitPoll until a Task needs you, completes, or fails.
atoi task cancelCancel a Task that is still active.
atoi task continueContinue completed or interrupted work with a new objective.

#task list

List Tasks, optionally within one Project.

atoi task list [--project <project-id>] [--limit <n>]

FlagTypeDefaultValuesWhat it does
--projectstringSelect a Project by id.
--limitnumberLimit the number of returned records.
--jsonbooleanfalseEmit the canonical JSON envelope.
--ndjsonbooleanfalseEmit one canonical JSON envelope per line.
--formatstringtexttext, jsonChoose human text or the JSON envelope.
--help -hbooleanShow command help.

#Run task list

bash
atoi task list --project prj_8k2v --json

#task start

Start durable implementation work in a Project.

atoi task start --project <project-id> (--prompt <text> | --brief <text>) [--title <title>] [--model <model-id>] [--profile <profile>] [--place <place>] [--computer <computer-id>] [--confirm]

FlagTypeDefaultValuesWhat it does
--project requiredstringSelect the Project that owns the Task.
--promptstringState the Task objective.
--briefstringState the Task objective with the compatibility flag.
--titlestringSet a Task title.
--modelstringSelect a model id.
--profilestringSelect the Task safety profile.
--placestringChoose cloud, none, host, or a Computer name.
--computerstringSelect an exact Computer id for host placement.
--confirmbooleanConfirm a placement choice when Atoi requires it.
--jsonbooleanfalseEmit the canonical JSON envelope.
--ndjsonbooleanfalseEmit one canonical JSON envelope per line.
--formatstringtexttext, jsonChoose human text or the JSON envelope.
--help -hbooleanShow command help.

#Run task start

bash
atoi task start --project prj_8k2v --prompt "Audit the release state and return evidence." --profile safe --place cloud --json

#task get

Read Task state, result, changes, checks, asks, and proof.

atoi task get <task-id> [--task <task-id>]

FlagTypeDefaultValuesWhat it does
--taskstringSelect a Task by id instead of a positional id.
--jsonbooleanfalseEmit the canonical JSON envelope.
--ndjsonbooleanfalseEmit one canonical JSON envelope per line.
--formatstringtexttext, jsonChoose human text or the JSON envelope.
--help -hbooleanShow command help.

#Run task get

bash
atoi task get tsk_3m9q --json

#task changes

Inspect the materialized, proof-linked Task change set.

atoi task changes <task-id> [--task <task-id>]

FlagTypeDefaultValuesWhat it does
--taskstringSelect a Task by id instead of a positional id.
--jsonbooleanfalseEmit the canonical JSON envelope.
--ndjsonbooleanfalseEmit one canonical JSON envelope per line.
--formatstringtexttext, jsonChoose human text or the JSON envelope.
--help -hbooleanShow command help.

#Run task changes

bash
atoi task changes tsk_3m9q --json

#task apply

Apply a verified change set to the matching local repository.

atoi task apply <task-id> --confirm --expected-change-set-id <id> --expected-change-set-fingerprint <fingerprint> [--directory <path>] [--idempotency-key <key>]

FlagTypeDefaultValuesWhat it does
--taskstringSelect a Task by id instead of a positional id.
--confirm requiredbooleanConfirm the exact consequential action after you inspect its target.
--expected-change-set-id requiredstringConfirm the change set id returned by task changes.
--expected-change-set-fingerprint requiredstringConfirm the change set fingerprint returned by task changes.
--directorystringcurrent directoryApply inside this matching local repository.
--idempotency-keystringReuse a mutation identity when you safely retry the same action.
--jsonbooleanfalseEmit the canonical JSON envelope.
--ndjsonbooleanfalseEmit one canonical JSON envelope per line.
--formatstringtexttext, jsonChoose human text or the JSON envelope.
--help -hbooleanShow command help.

#Run task apply

bash
atoi task apply tsk_3m9q --confirm --expected-change-set-id chg_7p4d --expected-change-set-fingerprint 0123456789abcdef --directory . --json

#task draft-pr

Publish a verified change set to a proof-backed draft pull request.

atoi task draft-pr <task-id> --confirm --expected-change-set-id <id> --expected-change-set-fingerprint <fingerprint> [--head <branch>] [--title <title>] [--body <body>] [--idempotency-key <key>]

FlagTypeDefaultValuesWhat it does
--taskstringSelect a Task by id instead of a positional id.
--confirm requiredbooleanConfirm the exact consequential action after you inspect its target.
--expected-change-set-id requiredstringConfirm the change set id returned by task changes.
--expected-change-set-fingerprint requiredstringConfirm the change set fingerprint returned by task changes.
--headstringChoose the draft pull request branch.
--titlestringSet the draft pull request title.
--bodystringSet the draft pull request body.
--idempotency-keystringReuse a mutation identity when you safely retry the same action.
--jsonbooleanfalseEmit the canonical JSON envelope.
--ndjsonbooleanfalseEmit one canonical JSON envelope per line.
--formatstringtexttext, jsonChoose human text or the JSON envelope.
--help -hbooleanShow command help.

#Run task draft-pr

bash
atoi task draft-pr tsk_3m9q --confirm --expected-change-set-id chg_7p4d --expected-change-set-fingerprint 0123456789abcdef --head task/release-audit --json

#task wait

Poll until a Task needs you, completes, or fails.

atoi task wait <task-id> [--task <task-id>] [--timeout-ms <ms>] [--interval-ms <ms>]

FlagTypeDefaultValuesWhat it does
--taskstringSelect a Task by id instead of a positional id.
--timeout-msnumber900000Stop polling after this many milliseconds.
--interval-msnumber2000Wait this many milliseconds between reads.
--jsonbooleanfalseEmit the canonical JSON envelope.
--ndjsonbooleanfalseEmit one canonical JSON envelope per line.
--formatstringtexttext, jsonChoose human text or the JSON envelope.
--help -hbooleanShow command help.

#Run task wait

bash
atoi task wait tsk_3m9q --timeout-ms 300000 --json

#task cancel

Cancel a Task that is still active.

atoi task cancel <task-id> [--task <task-id>]

FlagTypeDefaultValuesWhat it does
--taskstringSelect a Task by id instead of a positional id.
--jsonbooleanfalseEmit the canonical JSON envelope.
--ndjsonbooleanfalseEmit one canonical JSON envelope per line.
--formatstringtexttext, jsonChoose human text or the JSON envelope.
--help -hbooleanShow command help.

#Run task cancel

bash
atoi task cancel tsk_3m9q --json

#task continue

Continue completed or interrupted work with a new objective.

atoi task continue <task-id> (--prompt <text> | --brief <text>) [--title <title>] [--model <model-id>] [--profile <profile>] [--place <place>] [--computer <computer-id>] [--confirm]

FlagTypeDefaultValuesWhat it does
--taskstringSelect a Task by id instead of a positional id.
--promptstringState the continuation objective.
--briefstringState the continuation objective with the compatibility flag.
--titlestringReplace the Task title.
--modelstringSelect a model id.
--profilestringSelect the Task safety profile.
--placestringChoose cloud, none, host, or a Computer name.
--computerstringSelect an exact Computer id for host placement.
--confirmbooleanConfirm a placement choice when Atoi requires it.
--jsonbooleanfalseEmit the canonical JSON envelope.
--ndjsonbooleanfalseEmit one canonical JSON envelope per line.
--formatstringtexttext, jsonChoose human text or the JSON envelope.
--help -hbooleanShow command help.

#Run task continue

bash
atoi task continue tsk_3m9q --prompt "Apply the review findings and rerun checks." --place cloud --json

Was this useful?