agentleFS
Sign inStart free
foxrun-aifoxrun-ai/foxrun/AGENTS.md

foxrun

AGENTS.md6 starsChanged 17 days agoMITView on GitHub

Read this when you work inside the system home, the folder that holds this file. Links here are relative to it. Every other rule is in the global contract. Installed folders are copies of the product. An update replaces them, so never edit them by hand. To fix an installed file, file a bug with the fix. The fix ships in the next update. If a file named here is missing, say so and stop that write.

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

The file

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

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

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈4

    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. Distinctive:

    Read this when you work inside the system home, the folder that holds this file.

    line 10
  2. Distinctive:

    Every other rule is in the global contract.

    line 11
  3. Very specific:

    Before you change a part, read its owner's seat file in agents/.

    line 21
  4. Very specific:

    Run python3 base/ownership.py --home .

    line 28
  5. Very specific:

    After the change, run python3 foxrun.py doctor.

    line 30
  6. Distinctive:

    If a file named here is missing, say so and stop that write.

    line 32
  7. Very specific:

    Before a git action, read config/git.md, then config/git.local.md.

    line 36
  8. Distinctive:

    Keep private data and run trails out of git.

    line 37

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

System Home Contract

Read this when you work inside the system home, the folder that holds this file. Links here are relative to it. Every other rule is in the global contract.

What This Folder Is

  • This folder is the installed Foxrun system home: code, shared settings, the database, and the system agents.
  • Each folder's job is in DOCUMENTATION.md. Read its section before you change a folder you do not know.

Who Owns What

  • Each part has one writer. The table is in RESOLVER.md, section Who Owns What.
  • Before you change a part, read its owner's seat file in agents/.

Before You Write Here

Installed folders are copies of the product. An update replaces them, so never edit them by hand. To fix an installed file, file a bug with the fix. The fix ships in the next update.

  1. Run python3 base/ownership.py --home . write-check <path> from this folder. If it fails, stop.
  2. For a managed file, run python3 base/lint_gate.py --mode write --target <path> --body <draft-file>. If it fails, do not write.
  3. After the change, run python3 foxrun.py doctor. If it fails, fix it before you go on.

If a file named here is missing, say so and stop that write.

Installed Code

  • Before a git action, read config/git.md, then config/git.local.md.
  • Keep private data and run trails out of git.

Where The Starter Contract Is

  • A new person starts from config/templates/profile/AGENTS.md. The installer copies it to profile/AGENTS.md.
  • The person's own global contract is profile/AGENTS.md. Never overwrite it on an update.

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