agentleFS
Sign inStart free
michelbr84michelbr84/GarraRUST/AGENTS.md

GarraRUST

AGENTS.md19 starsChanged 21 days agoMITView on GitHub

GarraIA is a multi-crate Rust workspace (edition = "2024", rust-version = "1.97"). The main binary is garraia-cli (the binary itself is called garra); the HTTP/WS gateway lives in garraia-gateway. Always pass --exclude garraia-desktop. Its build.rs needs the GTK/glib system libraries and a Windows sidecar binary that a clean machine does not have, so a plain --workspace fails on something unrelated to your change. CI excludes it for the same reason (.github/workflows/ci.yml); desktop is built separately via scripts/build-installer.ps1. Note the package…

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

The file

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

1 rule. About 0 are common, 0 are distinctive, and 1 is 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.

  • 1

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    No external services (databases, Redis, etc.) are required for building or running tests.

    line 31

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

Cursor Cloud specific instructions

Project overview

GarraIA is a multi-crate Rust workspace (edition = "2024", rust-version = "1.97"). The main binary is garraia-cli (the binary itself is called garra); the HTTP/WS gateway lives in garraia-gateway.

Build, lint, and test

  • Build all: cargo build --workspace --exclude garraia-desktop
  • Build a single crate: cargo build -p garraia-gateway
  • Test a single crate: cargo test -p garraia-gateway
  • Test all: cargo test --workspace --exclude garraia-desktop
  • Lint: cargo clippy --workspace --exclude garraia-desktop --all-targets -- -D warnings
  • Format check: cargo fmt --all -- --check

Always pass --exclude garraia-desktop. Its build.rs needs the GTK/glib system libraries and a Windows sidecar binary that a clean machine does not have, so a plain --workspace fails on something unrelated to your change. CI excludes it for the same reason (.github/workflows/ci.yml); desktop is built separately via scripts/build-installer.ps1.

Note the package name: the CLI crate is garraia (binary garra), not garraia-cli — cargo test -p garraia-cli fails with "did not match any packages".

Notes

  • The workspace uses edition = "2024" and declares rust-version = "1.97" (bumped from 1.96; the reason is recorded inline in Cargo.toml next to the pin). The VM ships with a new enough toolchain.
  • No external services (databases, Redis, etc.) are required for building or running tests; SQLite is bundled via rusqlite with the bundled feature.
  • The gateway integration tests start their own ephemeral HTTP/WS servers on random ports — no manual server startup is needed.
  • The garraia-gateway crate depends on many workspace crates; initial compilation can take ~45 s.
  • Changelog fragments live in changelog.d/<section>/<issue>-<slug>.md. Never invent the number: open the GitHub issue first and use its real number. A fragment once shipped as 1748-... while #1748 was an unrelated, already-merged PR (#1750).

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