agentleFS
hranesshraness/personal-monorepo-template/kb/AGENTS.md

personal-monorepo-template / kb

AGENTS.md4 starsChanged 47 days agoMITView on GitHub

The file

We split this AGENTS.md into the rules it gives an agent

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

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈1

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 9

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    Treat kb/ as one Git-backed Markdown vault.

    line 11
  2. Very specific:

    Use vault-root wikilinks without .md, such as [[notes/example|example]].

    line 12
  3. Very specific:

    Treat reusable concepts as ordinary notes with type: concept.

    line 13
  4. Very specific:

    Put contextual relationships in prose or a compact ## Related section.

    line 14
  5. Distinctive:

    Search titles, aliases, filenames, and existing notes before creating a page.

    line 15
  6. Very specific:

    Put coordination artifacts in plans/, reusable current synthesis in notes/, and current operating instructions in repository guides or …

    line 16
  7. Very specific:

    Treat AGENTS.md as the normative, always-loaded control plane and scopes/ as optional rationale, history, examples, and graph routing.

    line 17
  8. Very specific:

    Start repository work with wordcell context <repository-path> --root kb --repo ., then expand through bounded links, exact metadata, or …

    line 20
  9. Very specific:

    After adding, moving, renaming, or materially revising a KB entry, use the percolate-kb skill on the changed note, then use refresh-kb or …

    line 21
  10. Very specific:

    Keep index.md concise and authored.

    line 23

≈ “Common” is an estimate: at least 1 in 5 of the 40,246 AGENTS.md 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
AGENTS.md

Contents

  • index.md – short authored front door for the vault.
  • articles/ – self-contained source captures with local attachments.
  • notes/ – maintained concepts, synthesis, and private reviewed Reading sources.
  • plans/ – proposed through terminal design and implementation plans.
  • scopes/ – pull-based context hubs mapped to repository AGENTS.md guides.

Guidelines

  • Treat kb/ as one Git-backed Markdown vault. Open this directory, not the repository root, as the vault.
  • Use vault-root wikilinks without .md, such as [[notes/example|example]]. Use Markdown links for web sources and repository files outside kb/.
  • Treat reusable concepts as ordinary notes with type: concept. Store typed outbound assertions under relations with lower-kebab-case predicates and exact vault-root target IDs; explain each assertion in prose or evidence.
  • Put contextual relationships in prose or a compact ## Related section. Never author reciprocal, inferred, transitive, or similarity-derived edges just to improve graph counts.
  • Search titles, aliases, filenames, and existing notes before creating a page. Update the existing note when identity is clear.
  • Put coordination artifacts in plans/, reusable current synthesis in notes/, and current operating instructions in repository guides or documentation.
  • Treat AGENTS.md as the normative, always-loaded control plane and scopes/ as optional rationale, history, examples, and graph routing. Keep every load-bearing edit-time rule in the applicable guide.
  • Preserve source authority and voice. Integrate source captures through maintained notes instead of silently rewriting captured material.
  • Publish Reading entries only through a reviewed notes/reading/ note and the checked generator. Ordinary notes and captures remain private.
  • Start repository work with wordcell context <repository-path> --root kb --repo ., then expand through bounded links, exact metadata, or search.
  • After adding, moving, renaming, or materially revising a KB entry, use the percolate-kb skill on the changed note, then use refresh-kb or run bun run kb:refresh and finish with bun run kb:check.
  • During parallel work, each lane edits only its owned notes and runs bun run kb:check:lane. The integrating agent performs the final refresh and normal check.
  • Keep index.md concise and authored. Use bun run kb:catalog for an exhaustive disposable inventory.

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.