Project Analyze

Documents

project-analyze

Project Analyze is an Agent Skill for documents published in the mylukin/agent-foreman repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.

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 ↗

QUICK START

How to use this skill

Bring this guide into your coding agent with a prompt tailored to the tool you use.

Open your project in Codex.
Copy and paste the prompt below.
Review files and risks before approving any action.

Prompt to paste

Inspect the Agent Skill at https://github.com/mylukin/agent-foreman/blob/HEAD/plugins/agent-foreman/skills/project-analyze/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/project-analyze, but wait for my approval before writing files or running scripts.

Copying this prompt does not install or run the skill. Review third-party files before use.

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