Use the CLI
Use the alterac.ai CLI
Understand when people and coding agents use the CLI, and how it resolves repository state.
The alterac.ai CLI is made for both people and coding agents. It connects a repository to an alterac.ai project and lets local coding agents receive and complete work.
When the installed stable executable is older, an ordinary command may print a best-effort version warning without delaying or changing that command. Follow its link to install the current CLI; the CLI does not update itself.
Before using Sprint or Milestone examples, check alterac-ai --version and the relevant command's --help. Older executables can lack the milestone family, task membership/filter/classification options, or Task Builder set-sprint and set-milestone. An unknown command or option needs a CLI version that includes that command; changing Project Settings or running docs-update cannot add it. Follow the installation guide, then check help again. Coding agents should report the missing command and ask the person to update the executable unless already directed to do so.
People normally initialize a repository, sign in, choose a local trust setting, and run the listener. Coding agents normally read work-run context, update Task Builder drafts, discover labels, create and edit Milestone records, and complete an assigned work run. This is guidance, not an access boundary: run a command only when the workflow or a person directs it.
- Install the CLI provides one-line installation, rerun-to-upgrade guidance, and uninstall steps for macOS, Linux, WSL, and Windows.
- Initialize and refresh repository guidance covers local setup.
- Listen for queued work covers local dispatch.
- Create a task and use work-run commands and use task and work-run commands cover agent-operated work.
Milestone metadata commands create, list, read, and update a project record with a required title, Markdown objective, and target. See Milestone records for exact syntax, organization-local dates, permissions, and recovery. Opening, closing, and deletion have no CLI commands. Direct task commands assign, replace, clear, and filter current Sprint and Milestone membership independently, with explicit classification for changes affecting Current history. Task Builder supports independent future Planned Sprint membership and Planned or Started Milestone membership, with explicit intent for Started targets and recovery by clearing stale draft assignments.
The CLI command reference lists every production command, its inputs, validation, state changes, and recovery.
