The commands used for interactive work, automation, and repair.
Sync, review, and recover
Daily commands
| Command | Behavior |
|---|---|
| docagent sync | Build a candidate vault and pause at the review gate. |
| docagent sync --yes | Approve automatically for controlled cron or CI use. |
| docagent status | Read-only explanation of what would change and why. |
| docagent resume RUN --approve | Promote an already reviewed staged vault. |
| docagent resume RUN --reject | Discard staging and keep the vault unchanged. |
| docagent rebuild | Force selected classes, sections, or the full documentation set to regenerate. |
| docagent validate | Validate source evidence, vault structure, or another selected root. |
| docagent spike | Run extraction and validation only for a file or directory. |
What to review
The run directory contains staging-vault/ with the complete candidate and preview.patch with the unified diff. Review technical claims, visible warnings, pending files, preserved engineer notes, and the run report before approving.
Exit codes
| Code | Meaning |
|---|---|
| 0 | Success without unresolved warnings. |
| 1 | Success with validation/extraction warnings or pending files. |
| 2 | Configuration, Git, safety, or unrecoverable runtime failure. |
| 3 | Review rejected or aborted; vault unchanged. |
| 4 | Lock conflict or stale resume assumptions. |