Help us improve
Share bugs, ideas, or general feedback.
From project-starter
Analyzes codebase structure, tech stack, patterns, and conventions for project onboarding and exploration.
npx claudepluginhub cloudai-x/claude-workflow-v2 --plugin project-starterHow this skill is triggered — by the user, by Claude, or both
Slash command
/project-starter:analyzing-projectsThe summary Claude sees in its skill listing — used to decide when to auto-load this skill
- **Trigger**: Onboarding to a new project, "how does this work" questions, codebase exploration, understanding unfamiliar code
Extracts tech stack, project structure, key patterns, and conventions from codebases via package.json scans, find, grep for JS/TS, Python, Go, Rust projects. Use before PRDs or planning.
Analyzes codebases for architecture, tech stack, patterns, scale, quality signals, and next steps via /sourceatlas:overview. Use when onboarding or querying project structure.
Generates a developer guide for unfamiliar codebases by scanning structure, mapping architecture, detecting conventions, analyzing key modules, and providing setup instructions.
Share bugs, ideas, or general feedback.
Copy this checklist and track progress:
Project Analysis Progress:
- [ ] Step 1: Quick overview (README, root files)
- [ ] Step 2: Detect tech stack
- [ ] Step 3: Map project structure
- [ ] Step 4: Identify key patterns
- [ ] Step 5: Find development workflow
- [ ] Step 6: Generate summary report
# Check for common project markers
ls -la
cat README.md 2>/dev/null | head -50
package.json → Node.js/JavaScript/TypeScriptrequirements.txt / pyproject.toml / setup.py → Pythongo.mod → GoCargo.toml → Rustpom.xml / build.gradle → JavaGemfile → RubyDockerfile, docker-compose.yml → Containerizedkubernetes/, k8s/ → Kubernetesterraform/, .tf files → IaCserverless.yml → Serverless Framework.github/workflows/ → GitHub ActionsPresent as a tree with annotations:
project/
├── src/ # Source code
│ ├── components/ # UI components (React/Vue)
│ ├── services/ # Business logic
│ ├── models/ # Data models
│ └── utils/ # Shared utilities
├── tests/ # Test files
├── docs/ # Documentation
└── config/ # Configuration
Look for and report:
Check for:
.eslintrc, .prettierrc → Linting/Formatting.husky/ → Git hooksMakefile → Build commandsscripts/ in package.json → NPM scriptsGenerate a summary using this template:
# Project: [Name]
## Overview
[1-2 sentence description]
## Tech Stack
| Category | Technology |
| --------- | ---------- |
| Language | TypeScript |
| Framework | Next.js 14 |
| Database | PostgreSQL |
| ... | ... |
## Architecture
[Description with simple ASCII diagram if helpful]
## Key Directories
- `src/` - [purpose]
- `lib/` - [purpose]
## Entry Points
- Main: `src/index.ts`
- API: `src/api/`
- Tests: `npm test`
## Conventions
- [Naming conventions]
- [File organization patterns]
- [Code style preferences]
## Quick Commands
| Action | Command |
| ------- | --------------- |
| Install | `npm install` |
| Dev | `npm run dev` |
| Test | `npm test` |
| Build | `npm run build` |
After completing analysis, verify:
Analysis Validation:
- [ ] All major directories explained
- [ ] Tech stack accurately identified
- [ ] Entry points documented
- [ ] Development commands verified working
- [ ] No assumptions made without evidence
If any items cannot be verified, note them as "needs clarification" in the report.