Generate comprehensive documentation for this codebase using agents-reverse-engineer.
<execution> Run the generate command in the background and monitor progress in real time.Steps
- •
Display version: Read
.claude/ARE-VERSIONand show the user:agents-reverse-engineer vX.Y.Z - •
Run the generate command in the background using
run_in_background: true:bashnpx agents-reverse-engineer@latest generate $ARGUMENTS
- •
Monitor progress by polling
.agents-reverse-engineer/progress.log:- •Wait ~15 seconds (use
sleep 15in Bash), then use the Read tool to read.agents-reverse-engineer/progress.log(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 progress.log doesn't exist 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
- •Root and per-package documents generated
- •Any inconsistency warnings from the quality report
This executes a three-phase pipeline:
- •
Discovery & Planning: Walks the directory tree, applies filters (gitignore, vendor, binary, custom), detects file types, and creates a generation plan.
- •
File Analysis (concurrent): Analyzes each source file via AI and writes
.sumsummary files with YAML frontmatter (content_hash,file_type,purpose,public_interface,dependencies,patterns). - •
Directory & Root Documents (sequential):
- •Generates
AGENTS.mdper directory in post-order traversal (deepest first, so child summaries feed into parents) - •Creates root document:
CLAUDE.md
- •Generates
Options:
- •
--dry-run: Preview the plan without making AI calls - •
--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/