agentleFS
Sign inStart free
salmandevsalmandev/everything-gemini/skills/repo-onboarding/SKILL.md

repo-onboarding

Skill2 starsChanged 29 days agoApache-2.0View on GitHub

Rapidly inspects an unfamiliar codebase, maps directory structures, identifies key patterns, and generates a structured Knowledge Item (KI) for permanent repository memory.

10 other projects use a version of this.

Adopted by

Most recently taken up by

Used with

Projects with it also use mcp-maintainer and release-guard.

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.
  • KhaiTrang1995Skill

    mcp-maintainer

    Operate and maintain the local MCP server for this repository. Use for MCP tool updates, policy-guard changes, host configuration, and MCP runtime troubleshooting.

    Also in 3 projects that use this

  • KhaiTrang1995Skill

    release-guard

    Run release-readiness checks for this repository. Use when validating docs, scripts, verification coverage, and operational safety before merge or release.

    Also in 3 projects that use this

The file

We split this skill into the rules it gives an agent

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

  • 0

    Common

    Most of the 10 edited versions we read keep these.

  • 3

    Distinctive

    This author's own choices. Worth a look.

  • 5

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    When an agent enters a new codebase, this skill provides a structured exploration sequence to index architecture, conventions, and …

    line 9
  2. Very specific:

    Read project manifest: package.json, pyproject.toml, go.mod, Cargo.toml.

    line 14
  3. Very specific:

    Check .gitignore to identify ignored artifacts, environment configs, and build outputs.

    line 15
  4. Distinctive:

    Check README.md and docs for local setup and testing scripts.

    line 16
  5. Very specific:

    Run list_dir on root and top-level directories to understand organizational patterns (e.g.

    line 19
  6. Distinctive:

    Run the project's build and test commands to verify environment health:

    line 24
  7. Very specific:

    Create metadata.json outlining core patterns, key paths, and test instructions.

    line 32
  8. Very specific:

    Create an architecture summary artifact in <appDataDir>/knowledge.

    line 33

“Common” is measured: kept by at least 6 in 10 of the 10 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

Repository Onboarding & Knowledge Item (KI) Indexing

When an agent enters a new codebase, this skill provides a structured exploration sequence to index architecture, conventions, and operational runbooks without wasting excessive context.

Onboarding Procedure

1. Root & Ecosystem Inspection

  1. Read project manifest: package.json, pyproject.toml, go.mod, Cargo.toml.
  2. Check .gitignore to identify ignored artifacts, environment configs, and build outputs.
  3. Check README.md and docs for local setup and testing scripts.

2. Architectural Survey

  1. Run list_dir on root and top-level directories to understand organizational patterns (e.g. Clean Architecture, Monorepo, MVC).
  2. Identify entry points (e.g., src/index.ts, app/main.py, cmd/server/main.go).
  3. Locate core data models and database schemas (e.g., Prisma schemas, SQLAlchemy models, migrations).

3. Build & Test Verification

Run the project's build and test commands to verify environment health:

# E.g.
npm run build && npm test

4. Create Repository Knowledge Item (KI)

Persist findings into the localized Knowledge Items store so subsequent sessions have instant architectural recall:

  • Create metadata.json outlining core patterns, key paths, and test instructions.
  • Create an architecture summary artifact in <appDataDir>/knowledge.

For the schema and structure of Knowledge Items, see references/knowledge-item-schema.md.

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.

Check your setup, free