codebase-onboard
Quickly map and explain an unfamiliar JavaScript/TypeScript or Python codebase — architecture, entry points, data flow, how to run it, and where to make a given change. Use whenever the user opens a new project, asks "explain this repo", "gimana struktur project ini", "where is X handled", "how does this work", or wants to start a task in code they don't know yet.
Target: Software development & testing. Automatically collected · unverified.
Excerpt from the author’s documentation
Extracted from a fixed version of SKILL.md in its original language. This is the author’s documentation; installation, compatibility and runtime results have not been verified by this site.
Read the original English text
Topics in the source
- Codebase Onboarding
- 1. Survey (cheap, broad)
- 2. Identify the shape
- 3. Trace one real flow end to end
- 4. Output
- 5. Optional: save it
Goal: give the user an accurate mental model fast, grounded in real files — not a generic description of the framework. Run scripts/projectmap.sh from the repo root. It prints the tree (ignoring vendor dirs), manifests, scripts, and largest source files. Then read, in order: README, package.json / pyproject.toml, CLAUDE.md / AGENTS.md / CONTRIBUTING.md if present, .env.example, docker-compose.yml, CI config (.github/workflows/). Decide what kind of project it is from evidence: Framework: Next.js (app/ or pages/), Vite/React, Express/Fastify/NestJS, FastAPI, Django (manage.py, settings.py), Flask, CLI tool, library, monorepo (turbo.json, pnpm-workspace.yaml, nx.json). Entry points: main/bin in package.json, src/index.ts, server.ts, main.py, app.py, manage.py, main.py. Data layer: Prisma/Drizzle/TypeORM/Mongoose, SQLAlchemy/Django ORM, migration folders. External services: env vars and SDK imports. Pick the most central feature (or the one the user cares about) and follow it: route/handler → service/business logic → data access → response. Name the actual files and functions. One concrete trace teaches more than ten folder descriptions. Use a Mermaid diagram only if the flow has more
This is an excerpt. Refer to the complete source and its current requirements.
- Source repository
- KILN-skills/kiln
- Source file
- skills/codebase-onboard/SKILL.md
- Fixed revision
- 555d7ea59d05910b4ef6fb39780da5f906be832b
Sources and evidence
This record was collected automatically. Its documentation, suitability and runtime behavior have not been manually verified.
Author: KILN-skills/kiln · original repository metadata. Documentation review: Not reviewed. Last source check: 2026-11-10T04:00:15.421Z.
Categories are inferred from names, descriptions and paths. They do not establish compatibility.
License and attribution
MIT. Third-party content and copyright remain with their authors. Refer to the original license and terms.
Original license ↗Synchronization, copying and user-reported success do not mark a resource as runtime-tested.
Limitations and notes
- Collecting metadata does not mean this site has installed, adapted, runtime-tested or security-reviewed the resource.