agentleFS
Sign inStart free
AnastasiyaWAnastasiyaW/crossweft/AGENTS.md

crossweft

AGENTS.md4 starsChanged 21 days agoApache-2.0View on GitHub

Python 3.9+, standard library only. Before a change is done, run the checks in CONTRIBUTING.md. This repository guards its own seams with crossweft, through the same harness it installs elsewhere: This repository keeps a map of its components and of every place where two of them must agree -- routes, headers, protocol versions, DTO fields, env vars, pipe names, duplicated algorithms -- in seams/model, and crossweft check verifies the map against the code. Agents write and maintain the map, and…

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

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

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈0

    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:

    Before editing a file another component depends on, run crossweft impact <path> (or the impact tool of crossweft mcp): it names the file on …

    line 16
  2. Very specific:

    Before you finish, crossweft check must print RESULT: PASS (exit 0.

    line 20
  3. Very specific:

    When you add a component, a connection, or a value two places must share, put it on the map in the same change: a block, a link with …

    line 25
  4. Very specific:

    Never weaken a guard, widen a regex, add an allow entry or a finding, run crossweft baseline (it is for adoption only), or attest a pair …

    line 32

≈ “Common” is an estimate: at least 1 in 5 of the 36,368 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

crossweft -- notes for coding agents

Python 3.9+, standard library only. Before a change is done, run the checks in CONTRIBUTING.md. This repository guards its own seams with crossweft, through the same harness it installs elsewhere:

<!-- crossweft-agents:begin (generated by `crossweft agents`; re-run it to update) -->

Component seams (crossweft)

This repository keeps a map of its components and of every place where two of them must agree -- routes, headers, protocol versions, DTO fields, env vars, pipe names, duplicated algorithms -- in seams/model, and crossweft check verifies the map against the code. Agents write and maintain the map, and the check makes sure it cannot drift from the code.

  • Before editing a file another component depends on, run crossweft impact <path> (or the impact tool of crossweft mcp): it names the file on the other side and the guard that compares them. Change both sides.
  • Before you finish, crossweft check must print RESULT: PASS (exit 0; 1 = problems, 2 = no verdict, which is never a pass). crossweft check --changed HEAD is a fast pre-commit check, not the final one. For Claude Code the hooks in .claude/settings.json do this for you: after each edit they name the other side, and they send you back while a seam disagrees.
  • When you add a component, a connection, or a value two places must share, put it on the map in the same change: a block, a link with anchors and contract.enforcement, and a guard that reads both sides for every hand-written seam (crossweft discover suggests guards; crossweft import derives them when one side is an OpenAPI or .proto schema). The crossweft skill has the full procedure, including mapping a repository from scratch.
  • Never weaken a guard, widen a regex, add an allow entry or a finding, run crossweft baseline (it is for adoption only), or attest a pair with --other-side-unchanged without re-reading every region, just to make the check pass; each needs a concrete reason.
<!-- crossweft-agents:end -->

Download now (ZIP)

  • 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 28,693 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.

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