memoryrail / rules
Cursor rule0 starsChanged 35 days agoMITView on GitHub
Project memory managed by MemoryRail
- Installs packages
Where files are headingNew Cursor rule files have more rules about planning and tracking tasks, and fewer about code style.
Of the Cursor rule files we read, the 4,157 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.
The file
We split this memoryrail.mdc 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
- Very specific: line 30
Before changing code, run memoryrail precheck "<what you plan to do>" --file <path> (or the MCP precheck tool).
≈ “Common” is an estimate: at least 1 in 5 of the 6,668 Cursor rule 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.
Files
--- description: Project memory managed by MemoryRail alwaysApply: true --- <!-- memoryrail:start --> ## Project memory (managed by MemoryRail) _Generated from `.memoryrail/`. Do not edit between these markers: change the memories, then run `memoryrail sync`._ ### Constraints - [CON-c9af] **Format changes must update docs/SPEC.md and spec/memory.schema.json, then be copied to memoryrail-si** — The website (private repo memoryrail-si) serves copies of the spec and the JSON Schema at memoryrail.si/spec. If the copies drift, the published spec is wrong. Copy both files there and redeploy after any format change. (files: docs/SPEC.md, spec/memory.schema.json) ### Decisions - [DEC-f623] **Search stays keyword-only; semantic search was built, measured and removed** — We built optional semantic search (OpenAI-compatible embeddings endpoint, git-ignored vector cache, hybrid ranking) in commit 69a3309 and reverted it. Reason: it needs a separate embedding server such as Ollama, which is a real setup hurdle, and it weakens the 'no network calls,… (files: src/search.ts) - [DEC-2e7c] **Client setup docs come from vendor docs, not memory; say what was not run** — docs/CLIENTS.md was written from the official Codex, VS Code and GitHub Copilot docs (checked 2026-10-10) and says plainly that we have not run Codex or Copilot against MemoryRail. Re-check the sources when a client changes; do not add a client config we have not read in its doc… (files: docs/CLIENTS.md) - [DEC-e952] **Gate agent writes with config review agents instead of always** — Default stays off: git review is enough for solo use, and a gate adds friction. When on, durable types written over MCP are proposed until a human approves. Proposals never retire the memory they supersede until approved. (files: src/store.ts, src/mcp.ts) - [DEC-7e9e] **Ideas from agent-memory, projectmem and Memory Trail are reimplemented, never copied** — Licenses differ (Apache-2.0, MIT, CC BY 4.0). We borrowed concepts only: precheck and doctor (projectmem), review gate, secret scan and install (agent-memory), short citable refs and stop-on-conflict (Memory Trail). Keep it that way; credit them in the README. (files: README.md) - [DEC-8755] **Project memory is plain Markdown in the repo** — No database or hosted service: files are reviewable in PRs, travel with clones, and need no account. Anything that breaks this property is out of scope for the core. (files: docs/SPEC.md) ### Gotchas - [GOT-81a2] **Codex reads at most 32 KiB of AGENTS.md by default** — project_doc_max_bytes defaults to 32 KiB across the whole instruction chain, so a large generated block gets cut off silently. doctor warns above 32 KiB. Keep per-memory text short in sync output. (files: src/sync.ts, src/doctor.ts) - [GOT-e8c2] **precheck --fail must ignore matches that are only a pinned rule** — Pinned constraints are always listed, so failing on any match would block every commit when used as a git hook. Fail only when a memory matched by file or by plan. (files: src/cli.ts, src/precheck.ts) - [GOT-f758] **Windows installs can miss rollup's native binary** — npm optional-dependency bug (npm/cli#4828): vitest fails with 'Cannot find module @rollup/rollup-win32-x64-msvc'. Fix: npm install --no-save @rollup/rollup-win32-x64-msvc@<rollup version>. ### Open threads - [THR-4c30] **Publish releases by hand until NPM_TOKEN is set** — 0.1.0 was published manually (npm login with 2FA, then npm publish --access public). The release workflow publishes on a v* tag only when the NPM_TOKEN repo secret exists, and skips if the version is already on npm. To automate: create an npm automation token and add it as the N… How to use this memory: - Before changing code, run `memoryrail precheck "<what you plan to do>" --file <path>` (or the MCP `precheck` tool). Use `memoryrail recall "<topic>"` for detail. - Cite the memory you rely on as `[per DEC-xxxx]`. If your plan conflicts with a constraint or decision, stop and ask instead of proceeding. - Record new decisions, approaches that failed, and gotchas with `memoryrail remember`. Finish a session with `memoryrail handoff`. <!-- memoryrail:end -->
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
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.