project-analyze

Name: project-analyze
Availability: InStock
Author: Lukin

Generate ARCHITECTURE.md documentation from codebase analysis.

247|20|Updated Nov 28, 2025

Search Tags:#architecture #code analysis #documentation #onboarding #AI agent #codebase mapping #project understanding

Ready to run

npx skills add https://github.com/mylukin/agent-foreman --skill project-analyze

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: project-analyze
Source: https://github.com/mylukin/agent-foreman/tree/main/plugins/agent-foreman/skills/project-analyze
Command: npx skills add https://github.com/mylukin/agent-foreman --skill project-analyze

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Understanding a new or complex codebase can be time-consuming and overwhelming. This Skill automates the process of generating comprehensive architecture documentation.

Core Features & Use Cases

Codebase Scanning: Automatically analyzes project files and structure.
Architecture Documentation: Generates a detailed ARCHITECTURE.md file, providing a clear overview.
Read-Only Operation: Safely explores the project without making any code changes or commits.
Use Case: You've just joined a new team or inherited a legacy project. Use this Skill to quickly generate an ARCHITECTURE.md file, giving you an immediate understanding of the codebase's structure and components.

Quick Start

Analyze the current project and generate its architecture documentation.

Frequently Asked Questions about project-analyze

High-intent search queries and answers about installing and using this skill.

FAQPage Schema

How do I generate architecture documentation from my codebase automatically?▼

Architecture documentation can be generated automatically by analyzing your project's file structure and components. This Skill scans your codebase and produces a detailed ARCHITECTURE.md file that maps the project structure, dependencies, and key components without requiring manual documentation or code changes.

Can I understand a new codebase quickly without making changes to the project?▼

Yes. Read-only codebase analysis safely explores project structure and generates comprehensive documentation without modifying code, making commits, or altering the repository. This makes it ideal for onboarding to unfamiliar projects or inheriting legacy codebases.

What does the architecture documentation output include?▼

The ARCHITECTURE.md output provides a structured overview of your project's organization, component relationships, and codebase structure. It maps how different parts of the project fit together, helping new team members and contributors understand the system design at a glance.

How do I customize where the architecture documentation is saved?▼

You can specify a custom output path using the --analyze-output flag when running the analysis. This lets you save the generated ARCHITECTURE.md file to any location in your project or working directory.

Can I get detailed output when analyzing a complex project?▼

Yes. Enable verbose mode using the --verbose flag to receive detailed analysis output while scanning your codebase. This provides deeper insights into the project structure and component relationships during documentation generation.