Onboard
Orient a developer to an unfamiliar codebase — how to build and run it, the high-level architecture, key directories, and where to start. Use when the user says "help me understand this repo", "onboard me", "what is this project", "how do I run this", "give me the lay of the land", or "where do I start".
Install
$ agentstack add skill-pradnyeshp-claude-skills-onboard ✓ scanned · ✓ verified — works with Claude Code, Cursor, and more.
Security review
✓ PassedNo issues found. Passed automated security review. · v0.1.0 How review works →
- ✓ Prompt-injection patterns
- ✓ Secret / credential exfiltration
- ✓ Dangerous shell & filesystem operations
- ✓ Untrusted network calls
- ✓ Known-malicious package signatures
What it can access
- ✓ Network access No
- ✓ Filesystem access No
- ✓ Shell / process execution No
- ● Environment & secrets Used
- ✓ Dynamic code execution No
From automated source analysis of v0.1.0. “Used” means the capability is present in the source — more access means more to trust, not that it’s unsafe.
About
Project signals
!ls 2>/dev/null
!cat README* 2>/dev/null | head -60
!ls package.json pyproject.toml Cargo.toml go.mod pom.xml Makefile docker-compose.yml .env.example 2>/dev/null
Instructions
Produce a concise orientation guide to this codebase (focused on $ARGUMENTS if an area was named). This is for a competent engineer who has never seen this repo — help them become productive fast.
What to cover
- What it is — one paragraph: the project's purpose and what it does, inferred from the README, manifests, and entry points.
- Tech stack — languages, frameworks, runtime, datastore, and notable libraries, read from the manifests and config.
- How to run it — the actual setup, build, run, and test commands. Pull these from
scriptsin package.json, a Makefile, CONTRIBUTING docs, or CI config. Note required env vars (check.env.example) and services (e.g. docker-compose). - Architecture map — the top-level directories and what each is responsible for. Identify the entry point(s) and trace the main flow at a high level (request → handler → service → data, or equivalent).
- Where to start — point to the 3–5 most important files to read first, and call out conventions a newcomer must know (testing approach, module boundaries, naming).
Rules
- Read before asserting — open the entry point and a few key files; don't guess the architecture from names alone.
- Cite real paths (
src/server.ts:1) so the reader can jump straight there. - Prefer commands you can verify exist (in scripts/Makefile/CI) over invented ones. If you can't confirm how to run it, say so and show your best guess clearly labeled.
- Keep it skimmable — headings, short bullets, a couple of
file:lineanchors. This is a map, not an essay. - Do not modify any files — this skill is read-only.
Source & license
This open-source skill is cataloged on AgentStack and links to its original source — we do not rehost the code.
- Author: Pradnyeshp
- Source: Pradnyeshp/Claude-Skills
- License: MIT
Install and usage instructions live in the source repository linked above.
Reviews
No reviews yet — be the first.
Write a review
Versions
- v0.1.0 Imported from the upstream source.