spencerpauly/awesome-cursor-skills/codebase-onboarding

Claude Code and agent skill by spencerpauly/awesome-cursor-skills

Trust tier 3
  • community
Source check pending

Checking that the SKILL.md file is still in the repository.

Launch multiple explore subagents in parallel to investigate architecture, data models, auth, APIs, and deployment. Synthesize into an onboarding document.

Install

npx vskill@latest install spencerpauly/awesome-cursor-skills/codebase-onboarding

SKILL.md

The same SKILL.md was published earlier as spencerpauly/awesome-cursor-skills/codebase-onboarding.

Codebase Onboarding

Generate a comprehensive onboarding document for a codebase by exploring it in parallel.

Workflow

1. Launch Parallel Explorers

Spawn 5 explore subagents, each investigating a different area:

Agent 1 — Architecture & Structure

"Map the top-level directory structure. Identify the framework (Next.js, Express, Django, etc.), monorepo tools (turbo, nx), and key config files. List every app/package and what it does."

Agent 2 — Data Models & Database

"Find all database schemas, ORM models, migrations, and seed files. List every entity, its fields, and relationships. Identify the database (Postgres, MySQL, MongoDB, etc.) and ORM (Prisma, Drizzle, SQLAlchemy, etc.)."

Agent 3 — API Routes & Endpoints

"Find all API route definitions. List every endpoint with its HTTP method, path, auth requirements, and what it does. Identify the API style (REST, GraphQL, tRPC)."

Agent 4 — Authentication & Authorization

"Find how auth works. Identify the auth provider (Auth.js, Clerk, Supabase Auth, custom), session management, protected routes, role/permission checks, and middleware."

Agent 5 — Deployment & Infrastructure

"Find deployment config (Dockerfile, Vercel config, fly.toml, terraform), CI/CD pipelines (GitHub Actions, etc.), environment variables needed, and how to run the app locally."
2. Synthesize

Combine the results from all 5 agents into a single onboarding document:

markdown
# Codebase Onboarding
## Quick Start
1.Clone the repo
2.Install dependencies: `<command>`
3.Set up environment: copy `.env.example` to `.env`
4.Run database migrations: `<command>`
5.Start dev server: `<command>`
## Architecture
<Agent 1 findings>
## Data Models
<Agent 2 findings>
## API Reference
<Agent 3 findings>
## Authentication
<Agent 4 findings>
## Deployment
<Agent 5 findings>
## Key Files to Know
-`<file>` — <why it matters>
3. Save

Write the document to ONBOARDING.md in the project root, or wherever the user specifies.

Tips

  • Each explore agent is read-only and fast — the whole process takes under a minute
  • For monorepos, consider one additional agent per app/package
  • The document should be opinionated — highlight the "start here" files, not just list everything
  • Include gotchas: common setup issues, env vars that are easy to forget, required system dependencies

Security

  • Security scanPassed, 95 of 100Pattern checks on the skill's files.
  • Model reviewPassed

Quality evaluation

  • Task evaluationNot runNo evaluation yet. Run one in Skill Studio.

Source

Popularity

Repository stars
683
Repository forks
108
7-day trend score
33

Stars and forks are for the whole GitHub repository, not this skill alone. Not refreshed yet.

Works with

Any agent vskill installs to: 56 targets in all. These 39 have a page on this site.

  • Claude Code
  • Cursor
  • GitHub Copilot
  • Windsurf
  • Codex
  • Gemini CLI
  • Cline
  • Amp
  • Roo Code
  • Goose
  • Continue
  • Kilo Code
  • Junie
  • Trae
  • OpenHands
  • Qwen Code
  • AI Agent
  • Tabnine Chat
  • Sourcegraph Cody
  • Amazon Q
  • Firebase Genkit
  • Sweep
  • Devin
  • Phind
  • Mentat
  • Claude Desktop
  • Aider
  • GPT Pilot
  • Plandex
  • bolt.new
  • v0
  • Replit Agent
  • Anse
  • TypingMind
  • BetterChatGPT
  • LibreChat
  • Warp AI
  • Pieces
  • Fig AI
Embed badge
vskill VERIFIED badge
[![vskill VERIFIED](https://verified-skill.com/api/v1/skills/spencerpauly/awesome-cursor-skills/codebase-onboarding/badge)](https://verified-skill.com/skills/spencerpauly/awesome-cursor-skills/codebase-onboarding)

Something wrong with this skill or its page? Tell us.