Repository onboarding skill
A downloadable agent skill that maps any unfamiliar codebase — stack, run commands, architecture, key flows and risky areas — without changing a file.
1Download or copy SKILL.md
Copy the file below. Permissions it uses: reads files and runs read-only shell commands (directory listings, search, git log). It asks before running builds or tests, never writes files unless you agree, and never prints secrets.
3 steps and 2 ready-to-use prompts are in the full version
Get this resource with editable variables, examples and future updates as part of a download pack.
Get Agent Skills Starter Kit — $19Example input
A Next.js + Prisma e-commerce repository; focus area: checkout and payment webhooks.
Example output
# Onboarding: shopfront ## In one paragraph A Next.js 15 storefront with a Postgres database via Prisma, deployed with Docker (Dockerfile, .github/workflows/deploy.yml)... ## Run it locally 1. pnpm install (pnpm-lock.yaml) 2. cp .env.example .env.local and fill STRIPE_SECRET_KEY, DATABASE_URL (names from .env.example) 3. pnpm db:migrate (package.json scripts) 4. pnpm test — CI runs "pnpm test --coverage" (.github/workflows/ci.yml) ## Key flows Checkout: app/checkout/page.tsx -> app/api/checkout/route.ts (creates session) -> webhook at app/api/webhooks/stripe/route.ts -> lib/orders.ts markPaid() ## Where to be careful lib/orders.ts has no tests and 14 commits in the last month (Inferred: active area).
Troubleshooting
- The skill doesn't trigger: ask explicitly ('use the repo-onboarding skill') and check the file is in a folder named after the skill.
- It tries to run the test suite: that's allowed only after asking; decline if you don't want it.
- Report is shallow on a monorepo: run it once per package and name the package as the focus area.
Known limitations
- Accuracy depends on what the agent reads; very large repositories may be summarised from a sample of files.
- Skill loading behaviour and install locations differ by tool and version; check your tool's documentation.