Skip to main content

CLI to list and link CursorCult rules.

Project description

CursorCult

Install (pipx)

pipx install cursorcult
cursorcult

If you need a specific Python version (e.g., 3.12):

pipx install --python python3.12 cursorcult

CursorCult is a library of small, opinionated Cursor rule packs. Each rule lives in its own repository and is meant to be copied into a codebase that wants to follow it.

Main organization page (browse all packs): https://github.com/CursorCult

How to use

  1. After installing cursorcult (above), run it to see released rule packs and pick the ones that match your project.
  2. Read the pack’s README.md to understand when it applies and how it interacts with other rules.
  3. Add rule packs into your project under .cursor/rules/:
    • Preferred: link them as git submodules (keeps you on tagged versions).
    • Optional: copy them in as plain files.
  4. Multiple packs coexist as siblings:
.cursor/rules/UNO/
.cursor/rules/Pinocchio/
.cursor/rules/TruthOrSilence/
...

CursorCult doesn’t prescribe which rules you must use—only provides clean, composable building blocks.

🏷️ Versioning Policy

CursorCult follows a strict stability contract based on semantic version tags.

  • v0 (Volatile):

    • The "dev/testing" channel.
    • Tags are mutable and may be force-pushed.
    • Opting into v0 means opting into bleeding-edge changes and potential breakage.
    • Tools will aggressively update v0 pointers to the latest commit.
  • v1+ (Stable):

    • The "stable" channel.
    • Tags are immutable. Once released, v1 code never changes.
    • Users on v1 stay on v1 until they explicitly upgrade to v2.
    • If you are on v0 and v1 is released, updates will promote you to v1.

Format

Every rule repo follows the same minimal format:

  • RULE.md — the ruleset itself, written in the modern Cursor style.
  • README.md — when to use the rule and any credits.
  • LICENSE — currently The Unlicense (public domain).

Rule repos are intentionally tiny and low‑ceremony. Contributions are via pull requests.

Cursor rule file format reference: https://cursor.com/docs/context/rules#rulemd-file-format

Discovering rules

CursorCult publishes many small rule repos. Instead of keeping a static list here, use the cursorcult CLI (installed above).

To install directly from GitHub:

pipx install git+https://github.com/CursorCult/_CursorCult.git

Web Search: Browse and filter all community rules at cursorcult.github.io.

This prints the released rules in the organization (repos with a vN tag), each repo’s one‑line description, latest tag version, and a link to its README.md. Repos without tags are treated as unreleased and are not listed.

List installed rules in your project:

cursorcult list

List all available rules from the org:

cursorcult list --remote

Updating rules

Update all installed rules to the latest tag (defaults to v0 if available):

cursorcult update

Update specific rules to specific tags:

cursorcult update UNO:v0 KISS:v1

Update a single rule to the latest available tag:

cursorcult update UNO

Linking a ruleset

Rulesets are named lists of rules registered in CursorCult/_rulesets.

Rulesets only include rules with a v0 tag; anything missing that requirement gets pruned.

cursorcult link --ruleset <RULESET>

To link from a local file containing newline- or space-separated rule names:

cursorcult link --ruleset-file path/to/rules.txt

To link a rule pack into your project as a git submodule:

cursorcult link <NAME>
cursorcult link <NAME>:v<X>
cursorcult link <NAME1> <NAME2> ...

link expects a .cursor/rules/ directory at your project root. It adds the chosen rule repo as a submodule under .cursor/rules/<NAME> and checks out the requested tag (default: latest vN).

If you want to edit the rule pack locally (for example, add globs or change apply mode), vendor it with git subtree instead:

cursorcult link --subtree <NAME>
cursorcult link --subtree <NAME>:v<X>

This copies the rule repo’s contents into .cursor/rules/<NAME> as normal files. You can update later with git subtree pull if desired.

To copy a rule pack into your project without using submodules:

cursorcult copy <NAME>
cursorcult copy <NAME>:v<X>
cursorcult copy <NAME1> <NAME2> ...

copy writes the pack’s LICENSE, README.md, and RULE.md into .cursor/rules/<NAME> at the requested tag.

Rule repos use simple integer tags (v0, v1, v2, …). The CLI itself is versioned with semantic versioning (vX.Y.Z).

Evaluating rules programmatically

Rules can define an evaluation workflow that runs generators, validates evidence, and evaluates the rule. The CLI supports this via:

cursorcult eval <RULE>

The CLI searches upward from .cursor/rules/<RULE>/RULE.md for a workflow file named .CC<RULE> (uppercase). If missing, eval fails.

Workflow file format:

  • Blank lines and lines starting with # are ignored.
  • Each line is a full command.
  • One line must be an evaluator with --input <path>.
  • One or more lines must be generators with --output <path> (and for UNO, --domain <name>).
  • All generator outputs must match the evaluator input.

Generators are run sequentially, then scripts/validate.py is run, then the evaluator line is executed.

Rules should provide scripts/validate.py and scripts/evaluate.py inside their rule pack. These are called after generation.

Example for UNO:

python .cursor/rules/UNO/scripts/generate.py --glob "src/**/*.py" --domain core --output defs.json
python .cursor/rules/UNO/scripts/generate.py --glob "tests/**/*.py" --domain tests --output defs.json
python .cursor/rules/UNO/scripts/evaluate.py --input defs.json

Testing rule packs

Rules can ship tests on a development branch that matches the deployed version (for example, v0, v1, ...), while keeping the main branch minimal. To run those tests against the currently installed rule scripts:

cursorcult test <RULE>

cursorcult test clones the repo at the installed ref into .cursor/rules/.cctests/<RULE>/<ref>/ and runs pytest there. It sets <RULE>_RULE_DIR so tests can target the installed scripts. If the rule is on v0, the tests should live on the t0 branch (not on main). If the rule is on v1, tests should live on the t1 branch, and so on.

If you installed with pipx, add pytest once:

pipx inject cursorcult pytest

You should add .cursor/rules/.cctests/ to your project .gitignore.

Creating a new rule pack

To propose a new rule pack in the CursorCult org, use the intake repo:

Maintainers can initialize a new rule repo with the standard template:

cursorcult new <NAME> --description "one-line summary"

This creates CursorCult/<NAME> and initializes:

  • LICENSE (Unlicense)
  • README.md (with install section)
  • RULE.md
  • .github/workflows/ccverify.yml

Release convention for new rules:

  • Develop on main with any number of commits while unreleased (no tags).
  • When ready for the first release, squash main to a single commit and tag it v0.
  • After any vN tags exist, tags must remain contiguous (v0, v1, v2, …). This is what cursorcult verify enforces.
  • main must only contain tagged vN commits (one commit per version).
  • Every version must have a matching tN branch with tests/ and requirements-test.txt.
  • tests/ and requirements-test.txt must never appear on main.
  • For v1+, the vN tag must match the tip of the corresponding vN branch, except for tests/ and requirements-test.txt.
  • requirements-test.txt can only include cursorcult and pytest.
  • Each vN branch must still be a valid rule repo after removing tests/ and requirements-test.txt.

Contributing

  • Open a PR against the relevant rule repo.
  • Keep changes focused and consistent with the rule’s voice: RULE.md is professional/exacting; README.md can be cheeky.
  • Before tagging a rule release, validate the repo format with cursorcult verify from a local clone.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

cursorcult-0.14.11.tar.gz (23.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

cursorcult-0.14.11-py3-none-any.whl (22.3 kB view details)

Uploaded Python 3

File details

Details for the file cursorcult-0.14.11.tar.gz.

File metadata

  • Download URL: cursorcult-0.14.11.tar.gz
  • Upload date:
  • Size: 23.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for cursorcult-0.14.11.tar.gz
Algorithm Hash digest
SHA256 108849873944e495283370830efa52952da3b03965bb0bdd668333aeaf70a707
MD5 16a95cc460fd835202af7ba93a71b79d
BLAKE2b-256 7190702f51e862237c3d72f045d5b7c945b0cca5d991c50bdb791164728dfc7c

See more details on using hashes here.

File details

Details for the file cursorcult-0.14.11-py3-none-any.whl.

File metadata

  • Download URL: cursorcult-0.14.11-py3-none-any.whl
  • Upload date:
  • Size: 22.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for cursorcult-0.14.11-py3-none-any.whl
Algorithm Hash digest
SHA256 4d48426c205e7839cea0f90bc2750ca792c822576be1edd228241d6649d25ec8
MD5 4e565e3207f1438ca51fa1dabe046f20
BLAKE2b-256 03c223bbf47ec9d227ff236b83ab72cd82ac714dc6578ccaab02d24f4e6703f4

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page