Documentation

The complete documentation for awa v0.3.1: 40 documents. Offline, awa help topics lists the operational topics, awa <command> --help gives command syntax, and awa docs export writes this whole bundle to a directory.

Machine consumers: the generated CLI reference (31036 bytes of JSON) describes every command, flag, and exit code; llms.txt maps this corpus, and llms-full.txt carries it in full as Markdown.

Operational topics

How to work with awa, written for direct retrieval.

awa for coding agents
golden-path workflow for LLM/coding agents
installing, verifying, and upgrading awa
download, verify, upgrade, and identify the binary
awa quick start — first project and first loop
initialize a project and run the first review loop
coding, review, specification, and fix loops
structure a coding, review, spec, or fix loop
awa status — the review dashboard
read the dashboard: baseline, drift, git, reuse, next
awa run — deterministic run cache
cache deterministic checks; hit/miss/replay model
awa run --record — supervised runs
always-execute history for non-cacheable commands
finding stored runs and their output
locate, read, verify, and delete stored run output
awa checkpoint — explicit checkpoints
user-authored worktree checkpoints
awa changes / awa diff
compare two states; default range latest..now
awa restore — repair selected paths from an immutable state
preview-first repair of selected paths from a stored state
state reference syntax
now, latest, @-N, run:<id>:before/after, restore:<id>:before, A..B
scan inputs and ignore rules
protected paths, .awaignore on, .gitignore off
awa doctor — diagnose and repair local state
diagnose and (with --repair) repair local state
awa gc — reclaim unreferenced local state
reclaim unreferenced checkpoints, runs, and blobs
diagnosing awa — slow, stale, blocked, or broken
symptom-to-command decision paths and recovery
awa local evidence and privacy
what .awa/ stores; keep it private and untracked
awa as a provider for other local tools
use awa as a state/evidence provider for other local tools
awa platform and filesystem support
supported platforms, filesystems, paths, and links
JSON output, exit origin, and script rules
envelope shape, partial-stream failure, exit origin
awa exit codes
stable process exit statuses 0–6 (plus 130 on interrupt)

Command reference

Exhaustive syntax for every command and flag.

awa command reference
every command and subcommand of the installed version
awa init
create a new .awa project in the current directory
awa status
show project status (default command)
awa checkpoint
record a checkpoint of the worktree
awa log
list recorded checkpoints
awa changes
summarize changes between two states
awa diff
show a diff between two states
awa restore
restore selected paths from an immutable state
awa run
run a command with caching and supervised history
awa gc
garbage-collect unreferenced state
awa doctor
diagnose project and store health
awa config
inspect or edit configuration
awa state
resolve and compare state for the external provider
awa docs
export the documentation of the installed version
awa help
show operational help for a topic
awa version
print version and build information

Reference

Configuration keys, global options, and the process-exit contract.

awa config — configuration schema, precedence, and when to change it
config schema, layers/precedence, and when to change it
awa global options
the global options every command is validated against
awa exit codes
the exact process-exit catalog and wrapped-child contract