project-analyze

mylukin's avatarfrom mylukin

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'.

⭐230stars🔀18forks📁View on GitHub🕐Updated Dec 24, 2025
[Architecture Design]

When & Why to Use This Skill

The Project Analyze skill is an automated codebase exploration tool designed to generate comprehensive architectural documentation (ARCHITECTURE.md). By performing a safe, read-only scan of a project's structure and files, it provides developers and AI agents with an immediate understanding of system design, component relationships, and codebase layout, significantly reducing the time required for manual discovery.

Use Cases

  • Developer Onboarding: Accelerate the process of joining an existing project by automatically generating a structural map of the codebase to understand how components interact.
  • AI Agent Initialization: Prepare a repository for AI-driven development by providing the necessary architectural context required for tools like agent-foreman to operate effectively.
  • Legacy Code Exploration: Safely survey and document the architecture of older or complex projects where documentation may be missing or outdated.
  • Pre-Refactoring Analysis: Gain a high-level overview of the project structure before making significant architectural changes to ensure all dependencies are accounted for.
nameproject-analyze
descriptionScans 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'.
allowed-tools[Bash, Read, Glob, Grep]
user-invocabletrue

🔍 Project Analyze

One command: agent-foreman init --analyze

Quick Start

agent-foreman init --analyze

Output: docs/ARCHITECTURE.md

Options

Flag Effect
--analyze-output ./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 init directly

Read-Only

No code changes. No commits. Safe to run anytime.