agentleFS
jblosseyjblossey/houserules/template/AGENTS.md

houserules / template

AGENTS.md2 starsChanged 20 days agoMITView on GitHub

Project knowledge — rules, invariants, gotchas, procedures, decisions, history — lives in knowledge/*.json. Every entry has an id. Every instruction above holds for any agent or harness reading this file. Two directories give Claude Code an extra, optional acceleration of the same rules — treat them as convenience, never as a requirement:

The file

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

4 rules. About 0 are common, 2 are distinctive, and 2 are 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.

  • 2

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Do not add knowledge to this file.

    line 14
  2. Very specific:

    Run houserules standing at the start of a session.

    line 18
  3. Very specific:

    Before you change a file, run houserules for <path> and read what comes back.

    line 19
  4. Distinctive:

    Every instruction above holds for any agent or harness reading this file.

    line 26

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

Project instructions

<!-- Replace this heading and line with your project's one-line identity. -->

Knowledge base

Project knowledge — rules, invariants, gotchas, procedures, decisions, history — lives in knowledge/*.json. Every entry has an id.

  • houserules topics lists the topics. houserules index --topic <t> lists a topic's entries.
  • houserules get <id>... prints full entries. houserules for <path>... prints the rules for the files you are about to change.
  • houserules standing prints the non-negotiables.
  • houserules check-knowledge is the lint gate of the knowledge base. houserules audit --base <ref> checks a change against its rule package.
  • Write every ruling to its home file in the same turn it is made: scope or product goes to a work item in the project's tracker, or to docs/ when the project has none; process goes to a knowledge entry (standing: true when non-negotiable); design goes to the spec. Then run houserules render and commit the generated files with the change.
  • Do not add knowledge to this file. Add an entry.

Workflow

  • Run houserules standing at the start of a session.
  • Before you change a file, run houserules for <path> and read what comes back.
  • Work items live in the project's tracker, once the project has one: houserules init --tracker json|github|beads installs it, and the houserules block below then names the commands that open and close a session on it.
  • Procedure docs live at .claude/skills/*/SKILL.md — plain markdown any agent can read.
  • houserules init --workflow reference installs the reference workflow, a set of lifecycle skills and agents for a project that wants them. Its install adds a ## Reference workflow section to the houserules block below.

Working with other harnesses

Every instruction above holds for any agent or harness reading this file. Two directories give Claude Code an extra, optional acceleration of the same rules — treat them as convenience, never as a requirement:

  • .claude/rules/*.md loads into Claude Code's context when you read a matching file: the rules of one area. houserules init --target claude writes these files. The standing rules reach every harness through the houserules block of this file; Claude Code reads it through CLAUDE.md. Other harnesses get the rules of an area from the AGENTS.md of its directory or from houserules for <path>.
  • .claude/agents/*.md are Claude Code subagent templates for handing a task to a fresh context; houserules init --workflow reference installs them. No instruction here depends on subagents existing.

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.