Skip to main content

Use the CLI

Use task and work-run commands

Discover project labels, record durable task comments, and retrieve or complete exact work runs.

Coding agents use these commands after a person has initialized the repository and queued work. A person can run them too when the workflow calls for it.

Create one immediate task

alterac-ai task create "Add concise task details." --title "Improve task creation"

This creates one Backlog task immediately; it does not queue work or create a work run. Add --mass, --exclude-from-metrics, repeated --label or --dependency, --plan, and --assignee when those details are known. Use Task Builder when you want to prepare related work or proposed Plans before publishing.

Inspect tasks before making direct changes

Use task list to choose the exact published task or inspect the members of one Plan before issuing a later direct task command. Plan filtering is inspection only; update published tasks individually with task update.

alterac-ai task list
alterac-ai task list --plan 12
alterac-ai task list --json

The default Markdown output orders tasks by their project-scoped number and shows the title, state, Mass, metric exclusion, labels, Plan membership, dependency status, assignee, and update time. Add --plan <planNumber> to inspect a Plan's current members. The Plan number must be positive and belong to the selected project. An unavailable Plan returns an error; an available Plan with no tasks returns a successful empty result. Use --project <projectId> to inspect another accessible project without changing this repository's configured selection. --json returns the same authoritative task records when another tool needs structured output.

Read a project task before changing it

alterac-ai task get <taskNumber>

This read-only command retrieves a project task's complete authoritative content and metadata before a direct update or deletion. A taskNumber is a positive number scoped to the selected project; it is not a task ID or the exact work-run GUID. Use --project <projectId> to select another accessible project without changing local configuration, or --json for the same structured response. The command does not retrieve comments or review history.

Discover available labels

alterac-ai labels

Use --json for structured output or --project <projectId> to inspect another accessible project without changing repository configuration.

Record a durable task decision

alterac-ai task comment <taskNumber> "Decision text"

Use a task number only for this command. File input is safer for multiline Markdown; see the command reference.

Retrieve and complete a work run

alterac-ai work-run get <taskWorkRunId>

Use the exact work-run GUID from the listener-launched command. After implementation, validation, and delivery are complete, submit both required outputs with alterac-ai work-run complete. The full syntax and completion boundary are in the CLI command reference.

If the organization license expires after a work run starts, work-run get and work-run complete remain available for that exact active run so it can reach review safely. Expiration still blocks creating, queueing, starting, recovering, or following up work. Restore the license before beginning another run; the CLI keeps stored authentication when it reports this problem.

The context records why the run was queued, the task's metric-exclusion choice at start, and, when applicable, the Plan that grouped the task when the run started. Plan details, labels, and the task exclusion choice remain fixed for the run even if live task or Plan metadata changes later. A fresh-start run includes a prominent instruction to begin from the immutable task snapshot and general comments without continuing earlier review feedback or agent output. JSON exposes the same state through executionOrigin, excludeFromMetrics, and the nullable plan value.