Generate comprehensive documentation for this codebase using agents-reverse-engineer.
Steps
Read version: Read
.claude/ARE-VERSION→ store as$VERSION. Show the user:agents-reverse-engineer v$VERSIONRun the generate command in the background using
run_in_background: true:npx agents-reverse-engineer@$VERSION generate --backend claude $ARGUMENTSMonitor progress by polling the latest progress log:
- Wait ~15 seconds (use
sleep 15in Bash), then use Glob to find the latest.agents-reverse-engineer/progress-*.logfile, and Read it (use theoffsetparameter to read only the last ~20 lines for long files) - Show the user a brief progress update (e.g. "32/96 files analyzed, ~12m remaining")
- Check whether the background task has completed using
TaskOutputwithblock: false - Repeat until the background task finishes
- Important: Keep polling even if no progress log exists yet (the command takes a few seconds to start writing)
- Wait ~15 seconds (use
On completion, read the full background task output and summarize:
- Number of files analyzed and any failures
- Number of directories documented
- Any inconsistency warnings from the quality report
This executes a two-phase pipeline:
File Analysis (concurrent): Discovers files, applies filters, then analyzes each source file via AI and writes
.sumsummary files with YAML frontmatter (content_hash,file_type,purpose,public_interface,dependencies,patterns).Directory Aggregation (sequential): Generates
AGENTS.mdper directory in post-order traversal (deepest first, so child summaries feed into parents), and writesCLAUDE.mdpointers.
Options:
--dry-run: Preview the plan without making AI calls--eval: Namespace output by backend.model for side-by-side comparison (e.g.,file.ts.claude.haiku.sum,AGENTS.claude.haiku.md)--concurrency N: Control number of parallel AI calls (default: auto)--fail-fast: Stop on first file analysis failure--debug: Show AI prompts and backend details--trace: Enable concurrency tracing to.agents-reverse-engineer/traces/
Converted and distributed by TomeVault — claim your Tome and manage your conversions.