agentleFS
otsalomaotsaloma/agent-setup/AGENTS.md

agent-setup

AGENTS.md0 starsChanged 44 days agoMITView on GitHub

You're running inside a Bubblewrap (bwrap) sandbox, your permissions are limited. If you encounter missing permissions for something you legitimately need to do, stop and ask for those permissions to be added rather than try to work around the problem. Be specific in your request: what permissions you need and why. /tmp is a tmpfs wiped whenever the sandbox restarts. Don't rely on files there persisting; keep anything reusable in the project, or recreate it and check it exists before…

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

The file

Show its rules and text

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

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

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈10

    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:

    Don't try to clobber (I have noclobber on)

    line 3
  2. Very specific:

    Don't wait for processes with pgrep -f PATTERN as it matches its own shell too

    line 4
  3. Very specific:

    Use www-open URL to open links in a browser

    line 5
  4. Distinctive:

    Start your commit message title with an appropriate verb like "Add", "Fix" or "Refactor" that describes the nature of the change.

    line 21
  5. Distinctive:

    When fixing an issue, make your commit message two short paragraphs: one to explain the problem and the other to explain the fix.

    line 24
  6. Distinctive:

    Never run git commit without my explicit go-ahead, regardless of the current permission/auto-accept mode.

    line 35
  7. Distinctive:

    Before committing, show me the full proposed commit message and wait for my approval.

    line 38
  8. Distinctive:

    Avoid extracting module-level constants for things used only once.

    line 51
  9. Distinctive:

    When a task has multiple clearly independent and unrelated parts, let's do them one at a time and let me review each separately before …

    line 58
  10. Distinctive:

    Prefer the simplest change that serves the current purpose or desired outcome.

    line 62
  11. Distinctive:

    When I ask how a tool, library, or API works, check the documentation or source code rather than guessing, and say clearly when you're …

    line 67
  12. Very specific:

    Avoid using something like sed -i to modify files.

    line 76
  13. Distinctive:

    When asking me a binary question, such as my approval for a git commit message or go-ahead to continue, ask simply as y/n, examples: …

    line 81
  14. Distinctive:

    Default to zero comments. Code, naming, and types should be self-explanatory.

    line 91

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

  • Don't try to clobber (I have noclobber on)
  • Don't wait for processes with pgrep -f PATTERN as it matches its own shell too
  • Use www-open URL to open links in a browser

Sandbox

You're running inside a Bubblewrap (bwrap) sandbox, your permissions are limited. If you encounter missing permissions for something you legitimately need to do, stop and ask for those permissions to be added rather than try to work around the problem. Be specific in your request: what permissions you need and why.

/tmp is a tmpfs wiped whenever the sandbox restarts. Don't rely on files there persisting; keep anything reusable in the project, or recreate it and check it exists before use.

Git Commits

Start your commit message title with an appropriate verb like "Add", "Fix" or "Refactor" that describes the nature of the change.

When fixing an issue, make your commit message two short paragraphs: one to explain the problem and the other to explain the fix. Otherwise, make your commit message one short paragraph. If fixing something related to a previous commit, reference that previous commit in the message by its short commit hash.

Wrap the commit message lines at 72 characters. Add yourself as Co-Authored-By, including your vendor, model and version, example:

Co-Authored-By: ACME Transformer 1.2 <noreply@acme.com>

Never run git commit without my explicit go-ahead, regardless of the current permission/auto-accept mode. "Commit" or "check and commit" in my message is permission to prepare the commit, not to run it silently. Before committing, show me the full proposed commit message and wait for my approval. If I approve, commit it as shown. If I ask for changes, revise and show it again before committing.

Locality of Behaviour

Try to follow this principle from Carson Gross:

The behaviour of a unit of code should be as obvious as possible by looking only at that unit of code.

Examples of what this means in practice:

Avoid extracting module-level constants for things used only once; this is especially true for single numbers; major multi-line structures are an exception. Avoid splitting logic of one thing across many files; a single feature should be as self-contained as possible.

Ways of Working

  1. When a task has multiple clearly independent and unrelated parts, let's do them one at a time and let me review each separately before moving on. We'll commit each logical change separately.
  2. Prefer the simplest change that serves the current purpose or desired outcome. Don't expand scope, add abstractions or introduce unit tests where they don't yet exist unless I ask. If something seems too complex or not worth it, say so.
  3. When I ask how a tool, library, or API works, check the documentation or source code rather than guessing, and say clearly when you're unsure. If needed, verify behaviour with a one-off test script.
  4. I frequently make manual edits between turns. When I say "check and commit" (or similar), review my changes for correctness before committing. Base your own edits on the latest state of the files on disk, not your previous changes or any cache.
  5. Avoid using something like sed -i to modify files. I want to see the diff of your changes as you make them and that works only if you use your higher-level tools. When expecting >10 matches, make an exception and use whatever is efficient.
  6. When asking me a binary question, such as my approval for a git commit message or go-ahead to continue, ask simply as y/n, examples: "Approve? (y/n)", "Continue to ...? (y/n)".
  7. Once done with implementation, silently check if the repository contains a TODO.md file. Check if there's an item corresponding to what you just did. If so, remove it. Likewise, silently check if the repository contains a NEWS.md file. Check if there's "PENDING" release notes. If your changes are user-visible, add an item there.
  8. Default to zero comments. Code, naming, and types should be self-explanatory. Only use comments to document (1) external bugs, quirks, and platform workarounds, (2) hidden side effects and non-obvious mechanics and (3) non-obvious domain rationale. Surrounding older code might have silly comments, but that is not license for you to be silly.

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.