agentleFS
Sign inStart free
Fable-ForgeFable-Forge/offline-ux-kit/AGENTS.md

offline-ux-kit

AGENTS.md0 starsChanged 2 months agoMITView on GitHub

These instructions apply to the entire repository.

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

The file

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

7 rules. About 1 is common, 2 are distinctive, and 4 are very specific to this project.

  • ≈1

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈2

    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:

    Run npm test after runtime, demo, report, packaging, or generated-output changes.

    line 16
  2. Very specific:

    Run python scripts/validate_repository.py after repository or publication metadata changes.

    line 17
  3. Very specific:

    Run an available Agent Skill validator after changing SKILL.md or agents/openai.yaml.

    line 18
  4. Very specific:

    Keep automated checks separate from real-browser acceptance in docs/VALIDATION.md.

    line 19
  5. Common:

    Do not collect input text, credentials, request bodies, URLs, error details, or imported business data.

    line 24
  6. Distinctive:

    Do not claim browser persistence, zero network requests, visual quality, or installation triggerability without direct evidence.

    line 25
  7. Distinctive:

    Do not add a release number or publish a release unless the user explicitly requests it.

    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

Repository Guidance

Scope

These instructions apply to the entire repository.

Source and generated files

  • assets/offline-ux.js is the runtime source.
  • examples/demo.html is the shared demo source.
  • scripts/build.cjs generates dist/; do not edit generated HTML or sample outputs by hand.
  • SKILL.md is the Agent workflow entrypoint. Keep detailed contracts in references/.

Required checks

  • Run npm test after runtime, demo, report, packaging, or generated-output changes.
  • Run python scripts/validate_repository.py after repository or publication metadata changes.
  • Run an available Agent Skill validator after changing SKILL.md or agents/openai.yaml.
  • Keep automated checks separate from real-browser acceptance in docs/VALIDATION.md.

Boundaries

  • Preserve the local-only, no-automatic-upload behavior.
  • Do not collect input text, credentials, request bodies, URLs, error details, or imported business data.
  • Do not claim browser persistence, zero network requests, visual quality, or installation triggerability without direct evidence.
  • Do not add a release number or publish a release unless the user explicitly requests it.

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