Skip to content

sagityang/single-project-analyzer

Repository files navigation

Single Project Analyzer

Languages: English | 简体中文

Platform License: MIT Claude Command Codex Skill

Single Project Analyzer is a reusable project-analysis workflow for deeply understanding one new project at a time. It guides an AI agent to collect evidence, inspect source code, compare alternatives, and produce Markdown plus offline-friendly HTML reports.

What It Does

Input one project:

GitHub repository, product website, npm package, PyPI package, or short project description

Produce structured analysis:

reports/          Markdown deep-dive reports
html_reports/     Offline HTML visual reports
HANDOVER.md       Handoff summary for the next agent

Quick Start

Claude Code Slash Command

Copy the command into a Claude Code workspace:

.claude/commands/analyze-project.md

Then run:

/analyze-project https://github.com/user/repo

Codex Skill

Copy the Skill folder into your Codex skills directory:

skills/single-project-analyzer

Then ask:

Use $single-project-analyzer to analyze https://github.com/user/repo.

Analysis Dimensions

# Dimension Question
1 Positioning What is this project really?
2 Architecture How is it built, and where are the key flows?
3 Models and APIs Does it call AI models or external services?
4 Cost What are the platform, model, and hidden costs?
5 Capability Boundary What does it handle well, and where does it fail?
6 Install and Run What is required to run it?
7 Integration CLI, API, SDK, MCP, plugins, or workflow hooks?
8 Ecosystem What are the closest alternatives?
9 Privacy Where do code, data, logs, and credentials go?
10 Follow-up Questions What would a careful user ask next?

Output Style

  • Evidence-backed conclusions with file paths, line references, or source links.
  • Clear distinction between verified facts, reasoned inferences, and untested assumptions.
  • Small-reader-friendly explanations with diagrams, tables, and summaries.
  • Offline HTML reports using local CSS only. No CDN, remote fonts, or remote images.

Repository Layout

.
├── .claude/commands/analyze-project.md
├── skills/single-project-analyzer/SKILL.md
├── references/analysis-framework.zh-CN.md
├── templates/html-report-template.html
├── README.md
├── README.zh-CN.md
├── PRIVACY.md
├── SECURITY.md
├── CONTRIBUTING.md
└── LICENSE

Privacy

This repository contains only public-safe templates and instructions. It intentionally excludes private conversation logs, handoff notes, real project reports, screenshots, credentials, and local machine paths.

Read PRIVACY.md before publishing generated reports.

License

MIT

About

Evidence-backed workflow for analyzing one project and producing Markdown and offline HTML reports.

Topics

Resources

License

Contributing

Security policy

Stars

3 stars

Watchers

0 watching

Forks

Releases

No releases published

Contributors

Languages