agentleFS
le4kerle4ker/mneme-template/AGENTS.md

mneme-template

AGENTS.md2 starsChanged 14 days agoMITView on GitHub

Personal Obsidian knowledge vault tracked with Git. Static markdown files — no build system or package manager. If you just created this vault from the template, invoke $setup in Codex. It will ask you which Areas you want to track and generate your personal vault structure and skills. Notes land in Resources/ when $process-inbox cannot confidently map them to an existing Area. They are not permanent residents — treat Resources/ as a staging ground, not an archive. Promote a resource…

  • Where files are headingNew AGENTS.md files have more rules about keeping secrets out of the code, and fewer about code style.

    Of the AGENTS.md files we read, the 31,542 first seen in the last six months, against the older ones: the kind of rule that gained most share, and the kind that lost most. About files like this in general, not this one, and an estimate, since a kind is a pattern in the words.

  • In this repository5 other files it gives its agents.

The file

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

10 rules. About 0 are common, 6 are distinctive, and 4 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈6

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 4

    Very specific

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

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

    If you just created this vault from the template, invoke $setup in Codex.

    line 10
  2. Distinctive:

    Promote a resource into an existing Area: when:

    line 26
  3. Distinctive:

    Promote a resource into a new Area: when:

    line 30
  4. Very specific:

    Leave a resource in Resources/: when:

    line 37
  5. Distinctive:

    Delete a resource: when:

    line 41
  6. Distinctive:

    Use markdown tables for structured data (gear specs, supplement dosages, financial accounts, etc.)

    line 62
  7. Very specific:

    Use Obsidian internal links for cross-references: [[Folder/Note Name]]

    line 64
  8. Distinctive:

    Every note starts with a single H1 title matching the filename, followed by content — no preamble

    line 68
  9. Distinctive:

    Use H2 and H3 headings only — never go deeper than H3

    line 70
  10. Very specific:

    Dates: use YYYY-MM-DD when the full date is known.

    line 71

≈ “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

AGENTS.md

Vault Overview

Personal Obsidian knowledge vault tracked with Git. Static markdown files — no build system or package manager.

Getting Started

If you just created this vault from the template, invoke $setup in Codex. It will ask you which Areas you want to track and generate your personal vault structure and skills.

Structure

  • Areas/ — Long-term areas of focus
  • Resources/ — Reference material that doesn't yet belong to a specific Area
  • Inbox/ — Quick capture

Resources Lifecycle

Notes land in Resources/ when $process-inbox cannot confidently map them to an existing Area. They are not permanent residents — treat Resources/ as a staging ground, not an archive.

Promote a resource into an existing Area when:

  • It turns out to be an addendum or extension of a note already in an Area.

Promote a resource into a new Area when:

  • Three or more related resources on the same topic have accumulated, signalling a recurring interest that warrants its own Area.
  • A single resource has grown substantially through repeated edits and is now actively maintained rather than passively referenced.

Leave a resource in Resources/ when:

  • It is passive reference material you consult occasionally but do not maintain.

Delete a resource when:

  • It is no longer relevant and unlikely to be referenced again.

The $review skill audits Resources/ at each periodic review and surfaces candidates for promotion, merging, or deletion.

Formatting

Prettier and markdownlint are configured. The pre-commit hook (.githooks/pre-commit) runs Prettier automatically on staged markdown files — no need to manually format before committing.

Rules (.markdownlint.yaml, .prettierrc.yaml):

  • Max line length: 100 characters (tables and code blocks exempt)
  • Prose wrap: always
  • Tab width: 2 spaces

Note Conventions

  • Use markdown tables for structured data (gear specs, supplement dosages, financial accounts, etc.)
  • Use Obsidian internal links for cross-references: [[Folder/Note Name]]
  • Link liberally — whenever a note mentions a concept, person, gear item, or topic that has its own note, link to it with [[Note Name]]
  • New notes in Areas/ should match the existing structure of that area
  • Every note starts with a single H1 title matching the filename, followed by content — no preamble
  • Use H2 and H3 headings only — never go deeper than H3
  • Dates: use YYYY-MM-DD when the full date is known; year only (2026) when only the year is known
  • Logs are reverse chronological — most recent entry first

Content Areas

<!-- Populated by $setup. Run it once to configure your Areas. -->

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.