project-analyze

verified

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

View on GitHub

Marketplace

agent-foreman-plugins

mylukin/agent-foreman

Plugin

agent-foreman

Repository

mylukin/agent-foreman

243stars

plugins/agent-foreman/skills/project-analyze/SKILL.md

Last Verified

January 18, 2026

Install Skill

Select agents to install to:

Scope:

npx add-skill https://github.com/mylukin/agent-foreman/blob/main/plugins/agent-foreman/skills/project-analyze/SKILL.md -a claude-code --skill project-analyze

Installation paths:

Claude

.claude/skills/project-analyze/

Instructions

# 🔍 Project Analyze

**One command**: `agent-foreman init --analyze`

## Quick Start

```bash
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.

Validation Details

Front Matter

Required Fields

Valid Name Format

Valid Description

Has Sections

Allowed Tools

Instruction Length:

556 chars