Menu
Maps an unfamiliar repo before touching its code.
Install with Codex or Claude Copy this prompt, paste it into Codex, Claude, or another assistant, and let it review the skill page and install it for you.
Based on SOC occupation classification
Flags risky shell commands and unsafe tree ops.
Detects high-confidence security risks in code.
Surfaces the dojo's non-negotiable prime directives.
Activates the dojo framework at the start of a session.
Plans multi-step work before writing code.
Captures lessons and promotes recurring patterns.
| name | codebase-onboarding |
| description | Maps an unfamiliar repo before touching its code. |
| tier | practical |
| category | workflow |
| created_by | human |
| platforms | ["windows","macos","linux"] |
| tags | ["onboarding","exploration","conventions"] |
| author | Andreas Wasita (@andreaswasita) |
Builds a working mental model of an unfamiliar repository before making changes: language, framework, structure, conventions, entry points, and test pattern. Does NOT exhaustively read every file — surveys strategically, then drills in where the work demands it.
view, grep, and glob Copilot tools.powershell tool to inspect files outside the source tree (lockfiles, etc.).1. Survey the top-level layout with `glob`.
2. Read manifest files (package.json, pyproject.toml, go.mod, *.csproj, pom.xml).
3. Read the README.
4. Identify the architecture pattern from directory names.
5. Open the entry point and one representative test.
6. Note conventions: naming, imports, error handling, test layout.
7. Write a short Quick Map (5–10 lines) for your future self.
| Survey target | Tool | Why |
|---|---|---|
| Top-level layout | glob '*' | Frames the project |
| Source layout | glob 'src/**' (or repo equivalent) | Spots architecture pattern |
| Manifests | view package.json / view pyproject.toml | Language, framework, scripts |
| README | view README.md | Author's intent |
| Entry point | view src/main.* / view cmd/main.go | How startup actually works |
| Tests | view one representative test | Pattern + framework |
| Directory signal | Architecture clue |
|---|---|
src/controllers/ or src/routes/ | MVC / route-based |
src/features/ or src/modules/ | Feature / domain-driven |
packages/ or apps/ | Monorepo |
src/components/ | Component-based frontend |
cmd/ and internal/ | Go standard layout |
src/main/java/ | Java / Spring |
Dockerfile + docker-compose.yml | Containerized service set |
Use glob on *, then on src/** (or the equivalent). Note top-level files. Use view on the manifest file for the stack — package.json, pyproject.toml, go.mod, *.csproj, pom.xml.
Open README.md with view. The author usually states the project's purpose, run instructions, and conventions in the first hundred lines.
Match the directory layout to the table above. Note any divergence — those are the "interesting" parts.
Open the entry file with view: src/main.ts, src/app.py, cmd/main.go, Program.cs. Trace the startup path one level deep. You are mapping shape, not deeply auditing logic.
Use glob to locate tests (**/*.test.*, **/test_*.py, **/*_test.go). Open one with view. Note framework, fixture style, and where tests live relative to source.
Write a 5–10 line summary for your own use (and to brief sub-agents):
## Quick Map: <repo-name>
- Language: TypeScript (strict mode)
- Framework: Next.js 14 (App Router)
- Tests: Vitest, co-located `*.test.ts`
- Patterns: Server Components default, Server Actions for mutations
- Entry: `src/app/layout.tsx`
- API: `src/app/api/`
- Models: `src/lib/models/`
- Build: `npm run build`. Deploy: Vercel.
view.