Docs · CLI reference
CLI reference
The commands you use day to day. Run any of them with --help for the same information in your terminal.
awos submit --repo PATH [--budget USD] [--privacy local_only|cloud_ok] "GOAL"
awos serve --worker [--once] [--poll SECONDS]
awos status [--digest] [JOB_ID]
awos cancel JOB_ID
awos unblock JOB_ID
awos keys [--json]awos submit
Queue a job and print its id.
awos submit --repo . --budget 0.50 "Add a --dry-run flag to the import command"| Argument | Meaning |
|---|---|
GOAL | What to get done. Quote it if it has spaces. |
--repo PATH | The git repository the job works on. Puts the job in the background worker's queue. |
--budget USD | Most the job may spend, in US dollars. Default 1.0; 0 means no cap. |
--privacy local_only|cloud_ok | local_only blanks cloud API keys for this job so it can only use a local model. Default cloud_ok. |
awos serve --worker
Run the background worker: take queued jobs one at a time until stopped.
| Flag | Meaning |
|---|---|
--worker | Run the queue worker. Without it, awos serve starts the local web dashboard instead. |
--once | Exit when the queue is empty. |
--poll SECONDS | Seconds between queue checks. Default 2. |
awos status
List the queue's jobs, or show one job when you pass its id.
| Argument | Meaning |
|---|---|
JOB_ID | Show one job's record. |
--digest | A short summary for humans: what is running, what is queued, what finished since the last digest, what is blocked (with the action to take), and today's spend. |
awos cancel
Cancel a job. A queued job is cancelled at once; a running job stops at its next step. A job that already finished is left as it is.
awos cancel <id>awos unblock
Re-queue a job that is blocked on credentials, after you fix the key. The attempt the block used is refunded. The worker also does this on its own once the keys check out again.
awos unblock <id>awos keys
Check each configured model provider without spending anything. Each check is a free, read-only request; key values are never printed.
| Status | Meaning |
|---|---|
ok | The provider answered and accepted the credential. |
unauthorized | 401 or 403: the key is wrong, revoked or out of credit. |
unreachable | No answer: offline, DNS, timeout or a server error. |
not-configured | No key set (for a local model: no server and no URL set). |
--json prints the same result as JSON.
Environment variables
| Variable | Meaning |
|---|---|
ANTHROPIC_API_KEY | Key for the default cloud model. |
AWOS_PROVIDER=local | Use your local model server. |
AWOS_HOST_DIR | Where the queue, job folders and reports live. Default ~/.awos/host. |