Explores a repository and generates a structured onboarding walkthrough for new team members. Covers tech stack, project structure, key files, architecture, and how to build/run/test.
This agent scans the repository for manifest files, config, entry points, and documentation. It reads key files to understand the architecture and generates a structured onboarding guide.
The agent is read-only — it never modifies project files.
Open Claude Code in the target repository, paste the contents of CLAUDE.md from this folder, then ask:
Explore this codebase and give me an onboarding walkthrough
cp codebase-onboarding/CLAUDE.md /path/to/your-project/.claude/commands/onboard.md
Then in Claude Code: /onboard
Read the file at /path/to/agents/codebase-onboarding/CLAUDE.md and follow those instructions for this repo
A structured markdown document covering:
- Tech stack (language, framework, database, testing, CI/CD)
- Project structure (annotated directory tree)
- Key files table
- Setup instructions (prerequisites, install, run, test)
- Architecture overview
- Where to find things (routes, models, logic, tests, config)
- Claude Code — Required
- No other dependencies