| name | project-analyze |
| description | Scans codebases to generate architecture documentation (ARCHITECTURE.md). Use when joining an existing project, understanding codebase structure, exploring project architecture, or preparing for agent-foreman init. Triggers on 'analyze project', 'understand codebase', 'explore architecture', 'scan project structure', 'survey project'. |
Project Analyze
One command: agent-foreman analyze
Quick Start
agent-foreman analyze
Output: docs/ARCHITECTURE.md
Options
| Flag | Effect |
|---|---|
./path/FILE.md |
Custom output path |
--verbose |
Show detailed progress |
Use When
- Joining existing project → understand before changing
- Before
agent-foreman init→ faster initialization
Skip When
- New/empty project → use
agent-foreman initdirectly
Read-Only
No code changes. No commits. Safe to run anytime.