Quickstart
Queue a ticket, let the worker run it, and review the branch. This takes about five minutes plus the time the job runs.
Requirements
- macOS or Linux with Python 3.12.
- A git repository to work on. Test verification uses
pytest, so a Python repo with tests gets the most out of the report. - A model: an Anthropic API key, or a local model server (see Models and cost).
1. Install
Early access members get the install command. Request access if you do not have it yet.
INSTALL_COMMAND
2. Add a model key
# cloud: Claude Haiku 5.5 is the default model
export ANTHROPIC_API_KEY=...
# check it without spending anything
awos keys
awos keys prints one line per provider: ok, unauthorized, unreachable or not-configured. Key values are never printed.
3. Queue a ticket
Run this from inside the repository. The goal is one sentence with a clear definition of done.
awos submit --repo . --budget 0.50 "Fix the date parser so 2024-02-29 is accepted"
It prints the job id. --budget is the most the job may spend, in US dollars (default 1.0). Queue as many tickets as you like; they run one at a time.
4. Start the worker
# keep running and take new jobs as they arrive
awos serve --worker
# or: work through the queue, then exit
awos serve --worker --once
Leave the first form running in a terminal. The queue lives on disk, so you can stop the worker and start it again later.
5. Review the result
# what finished, what is waiting on you, spend today
awos status --digest
# one job in detail
awos status <id>
# look at the change, then merge it or delete it
git diff main...awos/<id>
git merge --no-ff awos/<id>
git branch -D awos/<id>
Each finished job also writes report.md under ~/.awos/host/jobs/<id>/ with the goal, test results, cost, time and anything it was unsure about.
Next
- Concepts explains what happens inside a job.
- CLI reference lists every flag.
- Security and privacy covers local-only jobs and the secret scan.