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