agentleFS
emiliodominguezemiliodominguez/flow-skills/skills/flow-onboard/SKILL.md

flow-onboard

Skill1 starsChanged 48 days agoMITView on GitHub

First tour of an unfamiliar repository. Use when asked to explain how a codebase is organized, how a request flows through it, or where to start in a new repo. Hands off to `flow-plan`, `flow-diagnose` or `flow-repo-brief`.

The file

We split this skill into the rules it gives an agent

3 rules. About 0 are common, 2 are distinctive, and 1 is very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈2

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 1

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Read instructions, README, manifests, lockfiles, and CI.

    line 14
  2. Distinctive:

    Run relevant permitted commands.

    line 15
  3. Very specific:

    Write the map to the user's location or the repository's knowledge convention.

    line 19

≈ “Common” is an estimate: at least 1 in 5 of the 350,495 skill files we read have a rule of the same kind, not the same words. “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

Onboard

Build enough of a map to place the next change confidently. Explore breadth-first, then go deep on one representative flow instead of reading every file.

Process

  1. Read instructions, README, manifests, lockfiles, and CI. Find how to build, run, test, and lint, and the real entry points. Inspect scripts before running them so database resets, installs, or external actions are not mistaken for read-only checks.
  2. Run relevant permitted commands. Record verified, failed, and unrun commands separately with reasons. Missing credentials limit runtime claims, not the source-based map.
  3. Trace one real flow end to end: entry, routing, domain logic, storage or integration, result. Cite files and symbols at each boundary. Do not infer architecture from directory names.
  4. In a large repository, when authorized and available, assign independent read-only subsystem explorers. Ask each for purpose, key files and types, connections, and landmines in one compact shape. Small repositories need no fan-out.
  5. Distil the map to the files the next task needs, with conventions, invariants, ownership, and open questions. Separate enforced rules from observed precedent.
  6. Write the map to the user's location or the repository's knowledge convention. Use flow-repo-brief when it needs citations, freshness tracking, and reuse across sessions.

Anti-patterns

  • Calling source-based understanding runtime verification.
  • Running setup scripts that mutate external services.
  • Listing every file instead of tracing useful boundaries.
  • Blocking the whole map because one environment-dependent command cannot run.

Done when

  • Main commands and their verification status are known.
  • One real flow and its ownership boundaries are mapped with source locations.
  • The next task's conventions, landmines, and uncertainty are captured.

Continue with flow-plan, flow-diagnose for a specific bug, or flow-repo-brief for maintained context.

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.