agentleFS
poshan0126poshan0126/dotclaude/skills/onboard/SKILL.md

onboard

Skill871 starsChanged 5 months agoMITView on GitHub

Get oriented in an unfamiliar codebase fast. An Explore-subagent-driven tour that goes from a one-paragraph overview down to architecture, data models, auth, conventions, and a glossary — without flooding your main context. Use on a repo you're new to.

165 other projects use a version of this.

Adopted by

Most recently taken up by

Used with

Projects with it also use soak-test, team-live-ops and 10 more.

Other files people use alongside this one.

Files found in the same public projects as a version of this one, more often than they turn up anywhere else. Each project counts once, large collections count for less, and this file's own repository is left out.
  • lilangMaxSkill

    soak-test

    Generate a soak test protocol for extended play sessions. Defines what to observe, measure, and log during long play sessions to surface slow leaks, fatigue effects, and edge cases that only appear after sustained play. Primarily used in Polish and Release phases.

    Also in 9 projects that use this

  • lilangMaxSkill

    team-live-ops

    Orchestrate the live-ops team for post-launch content planning: coordinates live-ops-designer, economy-designer, analytics-engineer, community-manager, writer, and narrative-director to design and plan a season, event, or live content update.

    Also in 9 projects that use this

  • HK-hubSkill

    teach-impeccable

    One-time setup that gathers design context for your project and saves it to your AI config file. Run once to establish persistent design guidelines.

    Also in 19 projects that use this

  • CoralGameSkill

    project-stage-detect

    Automatically analyze project state, detect stage, identify gaps, and recommend next steps based on existing artifacts.

    Also in 15 projects that use this

  • CoralGameSkill

    team-level

    Orchestrate level design team: level-designer + narrative-director + world-builder + art-director + systems-designer + qa-tester for complete area/level creation.

    Also in 11 projects that use this

  • +5 more from lilangMax
  • +2 more from CoralGame

The file

We split this skill into the rules it gives an agent

3 rules. 0 are common, 3 are distinctive, and 0 are very specific to this project.

  • 0

    Common

    Most of the 153 edited versions we read keep these.

  • 3

    Distinctive

    This author's own choices. Worth a look.

  • 0

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    If the repo is empty or trivial (no source beyond config), say so plainly instead of padding the brief.

    line 54
  2. Distinctive:

    Prefer several focused Explore subagents over reading everything in the main context.

    line 60
  3. Distinctive:

    Don't invent structure you didn't verify.

    line 61

“Common” is measured: kept by at least 6 in 10 of the 153 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

Build a mental model of a codebase you're new to — broad first, then narrowing — the way the Claude Code onboarding recipe prescribes. Read only; never modify anything. Delegate the heavy reading to Explore subagents so their file dumps stay out of this conversation and only the summaries return.

Orientation (injected — already in front of you)

Top level:

ls -1 "${CLAUDE_PROJECT_DIR:-.}" 2>/dev/null | head -40

Manifests / entry points present at the root:

ls -1 "${CLAUDE_PROJECT_DIR:-.}" 2>/dev/null | grep -iE '^(package\.json|pyproject\.toml|go\.mod|cargo\.toml|gemfile|composer\.json|pom\.xml|build\.gradle|makefile|dockerfile|readme)' || echo "(no standard manifest at root — this may be a subdir or an unusual layout)"

Step 1: Dispatch the tour

Launch Explore subagents (in parallel where independent) to answer these, starting broad and narrowing. If $ARGUMENTS names a focus area, weight every prompt toward it.

  1. Overview — what this project is, who uses it, the top-level layout and what each major directory holds. Point the agent at the README and manifests first.
  2. Architecture — the main patterns, the entry points, how one request (or CLI invocation) flows end to end, and the module boundaries (what must not depend on what).
  3. Data models — the core domain types/entities/tables and their relationships, and where they're defined.
  4. Auth & security — how authentication and authorization work, where secrets/config load from, and the trust boundaries.
  5. Conventions — naming, file layout, test style and framework, error-handling and logging patterns, and the real build/test/lint commands from the manifests.

Each Explore prompt must ask for a tight summary with file:path pointers, NOT pasted file contents.

Step 2: Synthesize the brief

Merge the returns into one scannable onboarding brief — nothing pasted verbatim, everything a pointer:

# Onboarding: <project>

**What it is**: <2-3 sentences>
**Stack**: <languages, frameworks, key libraries>
**Architecture**: <the 3-5 load-bearing facts + entry points, as file:path>
**Data model**: <core entities and where they live>
**Auth & boundaries**: <how auth works, where secrets load>
**Conventions**: <naming, tests, error handling — the house style>
**Run it**: <build / test / lint commands>
**Glossary**: <project-specific terms an outsider wouldn't know>
**Start here**: <the 2-3 files to read first for the focus area>

If the repo is empty or trivial (no source beyond config), say so plainly instead of padding the brief.

Rules

  • Strictly read-only. This skill maps the code; it never changes it.
  • Summaries and file:line pointers only — never paste large files or diffs into the brief.
  • Prefer several focused Explore subagents over reading everything in the main context; keeping exploration out of this conversation is the whole point.
  • Don't invent structure you didn't verify. If an area (e.g. auth) doesn't exist, say "none found" — don't fabricate one.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.