agentleFS
baobachbaobach/llm-wiki-vault/template/AGENTS.md

llm-wiki-vault / template

AGENTS.md0 starsChanged 18 days agoMITView on GitHub

A Zettelkasten-style Obsidian vault maintained together with AI coding agents. Claude Code reads this file through CLAUDE.md; Codex and Hermes Agent read it directly. Edit rules here, never in CLAUDE.md. - raw/: sources waiting to be digested (web clips, PDFs, transcripts, photos of handwritten notes). Agents read it and never edit, move, or delete it. It is transient: the owner clears it after digestion, so no note may link, embed, or cite a raw/ path. - Fleeting Notes/: quick captures,…

  • 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,700 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 repository6 other files it gives its agents.

The file

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

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

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈5

    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:

    Never promote a note to Literature or Permanent without the owner's approval.

    line 43
  2. Very specific:

    Never move or delete a fleeting note.

    line 44
  3. Distinctive:

    Keep technical terms, code, and quotes exactly as they are.

    line 59
  4. Distinctive:

    After the write, it commits only the files it created, then pushes.

    line 75
  5. Distinctive:

    If the pull or the push fails, it stops and tells the owner.

    line 76
  6. Distinctive:

    If obsidian-git runs on the main machine, it commits on a timer.

    line 78

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

External Brain: guide for AI agents

A Zettelkasten-style Obsidian vault maintained together with AI coding agents. Claude Code reads this file through CLAUDE.md; Codex and Hermes Agent read it directly. Edit rules here, never in CLAUDE.md.

Folders

  • raw/: sources waiting to be digested (web clips, PDFs, transcripts, photos of handwritten notes). Agents read it and never edit, move, or delete it. It is transient: the owner clears it after digestion, so no note may link, embed, or cite a raw/ path.
  • Fleeting Notes/: quick captures, type: fleeting. Every new note lands here.
  • Literature Notes/: synthesized write-ups of several fleeting notes or sources, type: literature.
  • Permanent Notes/: reference-quality notes, rarely edited, type: permanent.
  • Files/: images and attachments that notes embed.
  • Templates/: note templates. Quote {{placeholders}} inside frontmatter.
  • outputs/: generated reports and drafts waiting for review.
  • Index.md: topic-grouped catalog of every note, generated by wiki_index.py from frontmatter and index_sections.json (run by /wiki). Never edit it by hand. Read it first to find notes; then read the notes themselves.
  • Log.md: append-only log, one line per change. Read only its last 30 lines.

Frontmatter

---
title: "Note title"
type: fleeting          # fleeting | literature | permanent
created: 2026-01-31T09:00:00
updated:
tags: ["#tag"]
topic: ["[[Concept Note]]"]
sources: []             # URL, DOI, [[note]], or a plain description; never raw/
---

Rules

  • Distill, don't transcribe. A fleeting note is a few dense bullets.
  • Link related notes with [[wikilinks]]; prefer an existing topic over a new one.
  • Never promote a note to Literature or Permanent without the owner's approval.
  • Never move or delete a fleeting note. After a promotion, append Promoted to [[New Note]] to its last line.
  • A fact added from outside the vault is marked as LLM-suggested, with a source.
  • Log every write in Log.md (Hermes uses Log-hermes.md): - YYYY-MM-DD | <agent> | <skill> | what changed.

Writing style

A light version of ASD-STE100 Simplified Technical English, for all new text.

  • One instruction per sentence; steps in the imperative, at most 20 words.
  • Descriptive sentences at most 25 words; one topic per paragraph.
  • Active voice. The same word for the same thing every time.
  • Common words: use, start, make sure, before (not utilize, commence, ensure, prior to). A vertical list for three or more parallel items.
  • Keep technical terms, code, and quotes exactly as they are.

Write lock

One agent writes at a time. Before any write, run mkdir -p .locks && mkdir .locks/vault-write.lock. The second mkdir fails if another agent holds the lock. Then write <agent> | <ISO time> | <task> to .locks/vault-write.lock/owner. Remove the lock directory when the whole operation is done. A lock older than 30 minutes is stale, but ask the owner before removing it.

Git sync

The lock works on one machine only, because .locks/ is not synced.

  • An agent on a second machine runs git pull --rebase before every write.
  • After the write, it commits only the files it created, then pushes.
  • If the pull or the push fails, it stops and tells the owner. It never resolves a conflict itself.
  • If obsidian-git runs on the main machine, it commits on a timer. Don't commit routine edits by hand.

Agents and roles

  • Claude Code and Codex: all skills (/digest, /wiki, /qna, /lint, /explain).
  • Hermes Agent on a small local model: /qna, and /digest into new fleeting notes only. It never edits existing notes, rebuilds Index.md, promotes, or applies lint fixes, and it logs to Log-hermes.md instead of Log.md. The skills it must not run (/wiki, /lint, /explain) say so in their first line.

About this file

Installed by llm-wiki-vault (https://github.com/baobach/llm-wiki-vault). Change it freely: install.sh --update-skills updates the skills, wiki_lint.py, and wiki_index.py, and never touches this file.

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.