CRUX-Compress / rules
Cursor rule8 starsChanged 2 months agoMITView on GitHub
CRITICAL: Do NOT add files to scripts/create-crux-zip.py unless the user explicitly instructs you to add a file to the distribution zip. The file scripts/create-crux-zip.py defines the exact contents of the CRUX Compress distribution package. Changes to this file directly affect: These are the ONLY files that should be in the distribution: The distribution zip should remain minimal and focused. Additional files: - Increase download size for users - May conflict with user's existing configurations - Require users to update more…
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,181 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 repository35 other files it gives its agents.
- AGENTS.mdAGENTS.md
- .cursor/rules/crux-memories-integration.crux.mdcCursor rule
- .cursor/rules/crux-memories-integration.mdCursor rule
- .cursor/rules/_CRUX-RULE.mdcCursor rule
- .cursor/rules/docs-sync.crux.mdCursor rule
- .cursor/rules/docs-sync.crux.mdcCursor rule
- .cursor/rules/docs-sync.mdCursor rule
- .cursor/rules/example/coding-standards-demo.crux.mdcCursor rule
- .cursor/rules/example/coding-standards-demo.mdCursor rule
- .cursor/rules/ignore-example-rules.crux.mdCursor rule
- .cursor/rules/ignore-example-rules.crux.mdcCursor rule
- .cursor/rules/ignore-example-rules.mdCursor rule
- .cursor/rules/skill-and-agent-references.mdcCursor rule
- .cursor/rules/spec-agent-allocation.crux.mdCursor rule
- .cursor/rules/spec-agent-allocation.crux.mdcCursor rule
- .cursor/rules/spec-agent-allocation.mdCursor rule
- .cursor/rules/spec-implementation-hygiene.mdcCursor rule
- .cursor/rules/version-bump.crux.mdCursor rule
- .cursor/rules/version-bump.crux.mdcCursor rule
- .cursor/rules/version-bump.mdCursor rule
- .cursor/rules/zip-contents-protection.crux.mdCursor rule
- .cursor/rules/zip-contents-protection.crux.mdcCursor rule
- crux-skill-memory-compressSkill
- crux-skill-memory-crudSkill
- crux-skill-memory-extractSkill
- crux-skill-memory-indexSkill
- crux-skill-memory-meditation-coordinationSkill
- crux-skill-memory-meditation-ensembleSkill
- crux-skill-memory-meditation-quickSkill
- crux-skill-memory-meditation-reportSkill
- crux-skill-memory-meditation-researchSkill
- crux-skill-memory-meditation-reviewSkill
- crux-skill-memory-rebalanceSkill
- crux-skill-memory-reference-trackerSkill
- crux-utilsSkill
The file
We split this zip-contents-protection.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
- Very specific: line 8
CRITICAL: Do NOT add files to scripts/create-crux-zip.py unless the user explicitly instructs you to add a file to the distribution zip.
- Very specific: line 32
Update scripts/create-crux-zip.py with the new file/directory
- Very specific: line 33
Run scripts/create-crux-zip.py so .crux/dist-manifest.json records the new path
- Very specific: line 34
Update the "Release-Relevant Files" table in CONTRIBUTORS.md
≈ “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
Zip Contents Protection Rule
CRITICAL: Do NOT add files to scripts/create-crux-zip.py unless the user explicitly instructs you to add a file to the distribution zip.
Protected Script
The file scripts/create-crux-zip.py defines the exact contents of the CRUX Compress distribution package. Changes to this file directly affect:
- What users receive when installing CRUX Compress
- What triggers version bumps (via
.github/workflows/version-bump.ymlRELEASE_PATHS) - The size and scope of the distribution
Rules
NEVER automatically add files to the zip script when:
- Creating new cursor rules (
.cursor/rules/*.mdc) - Creating new skills (
.cursor/skills/*/) - Creating new scripts (
scripts/*.py) - Creating any other files in the repository
ONLY modify the zip script when:
- The user explicitly says "add X to the distribution zip"
- The user explicitly says "include X in the release"
- The user asks to modify the zip contents
When adding files to the zip (with explicit permission):
- Update
scripts/create-crux-zip.pywith the new file/directory - Run
scripts/create-crux-zip.pyso.crux/dist-manifest.jsonrecords the new path - Update the "Release-Relevant Files" table in
CONTRIBUTORS.md - Inform the user that adding files will trigger a version bump on next commit
Current Zip Contents
These are the ONLY files that should be in the distribution:
CRUX.md
install.crux.md
.crux/crux.json
AGENTS.crux.md (extracted from AGENTS.md)
.cursor/hooks.json
.cursor/agents/crux/crux-cursor-rule-manager.md
.cursor/agents/crux/crux-cursor-memory-manager.md
.cursor/agents/crux/crux-cursor-meditation-guide.md
.cursor/commands/crux/crux-compress.md
.cursor/commands/crux/crux-amnesia.md
.cursor/commands/crux/crux-dream.md
.cursor/commands/crux/crux-forget.md
.cursor/commands/crux/crux-meditate.md
.cursor/commands/crux/crux-recall.md
.cursor/commands/crux/crux-remember.md
.cursor/hooks/crux-detect-changes.py
.cursor/hooks/crux-detect-memory-changes.py
.cursor/hooks/crux-session-start.py
.cursor/rules/crux/_CRUX-RULE.mdc
.cursor/rules/crux/crux-memories-integration.crux.mdc
.cursor/skills/crux/crux-utils/SKILL.md
.cursor/skills/crux/crux-utils/scripts/crux-utils.py
.cursor/skills/crux/crux-skill-memory-crud/SKILL.md
.cursor/skills/crux/crux-skill-memory-compress/SKILL.md
.cursor/skills/crux/crux-skill-memory-extract/SKILL.md
.cursor/skills/crux/crux-skill-memory-index/SKILL.md
.cursor/skills/crux/crux-skill-memory-index/scripts/memory-index.py
.cursor/skills/crux/crux-skill-memory-index/scripts/post-dream.py
.cursor/skills/crux/crux-skill-memory-rebalance/SKILL.md
.cursor/skills/crux/crux-skill-memory-reference-tracker/SKILL.md
.cursor/skills/crux/crux-skill-memory-meditation-research/SKILL.md
.cursor/skills/crux/crux-skill-memory-meditation-quick/SKILL.md
.cursor/skills/crux/crux-skill-memory-meditation-ensemble/SKILL.md
.cursor/skills/crux/crux-skill-memory-meditation-review/SKILL.md
.cursor/skills/crux/crux-skill-memory-meditation-report/SKILL.md
.cursor/skills/crux/crux-skill-memory-meditation-coordination/SKILL.md
.crux/crux-release-files.jsonRationale
The distribution zip should remain minimal and focused. Additional files:
- Increase download size for users
- May conflict with user's existing configurations
- Require users to update more frequently
- Increase maintenance burden
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.