project-summary

# project-summary — Instant Codebase Overview

Generate a structured project summary for onboarding developers or providing context to agents.

## Steps

### 1. Scan Project Root

Read these files first (all optional):
- `package.json` / `pyproject.toml` / `Cargo.toml` / `go.mod` / `*.sln` / `*.csproj`
- `README.md` — existing description
- `LICENSE`
- `Dockerfile` / `docker-compose.yml`
- `.github/workflows/*.yml` / `.gitlab-ci.yml` / `Jenkinsfile`
- `tsconfig.json` / `babel.config.*` / `webpack.config.*` / `vite.config.*`
- `.eslintrc*` / `.prettierrc*` / `pyproject.toml [tool.ruff]`

### 2. Detect Language & Framework

**Primary language** — count file extensions:
```bash
find . -type f -not -path '*/node_modules/*' -not -path '*/.git/*' -not -path '*/dist/*' -not -path '*/target/*' -not -path '*/__pycache__/*' -not -path '*/.venv/*' | sed 's/.*\.//' | sort | uniq -c | sort -rn | head -10
# Windows:
Get-ChildItem -Recurse -File -Exclude node_modules,.git,dist,target | Group-Object Extension | Sort-Object Count -Descending | Select-Object -First 10 Count,Name
```

**Framework** — check dependencies (see readme-generator skill for detection table).

### 3. Map Architecture

Identify the architecture pattern from directory structure:

| Structure | Pattern |
|-----------|---------|
| `src/controllers/`, `src/models/`, `src/routes/` | MVC |
| `src/features/*/`, each with components+hooks+api | Feature-based |
| `src/domain/`, `src/application/`, `src/infrastructure/` | Clean Architecture / DDD |
| `pages/` or `app/` (Next.js/Nuxt) | File-based routing |
| `cmd/`, `internal/`, `pkg/` | Go standard layout |
| `src/lib.rs`, `src/main.rs` | Rust binary/library |
| Flat structure, few files | Simple / Script |

### 4. Identify Entry Points

```bash
# Look for common entry points
ls -la src/index.* src/main.* app.* main.* index.* manage.py server.* 2>/dev/null
# Check package.json "main", "module", "bin", "scripts.start"
# Check Cargo.toml [[bin]] or src/main.rs
# Check py...