Skip to content

Latest commit

 

History

History
126 lines (111 loc) · 8.94 KB

File metadata and controls

126 lines (111 loc) · 8.94 KB

Cursor Agents Guide (Using Cursor Rules)

This document explains how to use the rules in this repository with Cursor and serves as a single entry point that references the existing rule files. It avoids duplication by linking directly to the .cursor/rules/*.mdc sources.

If you installed these rules via the installer, a project‑local AGENTS.md can be generated that lists only the rules you chose. By default, the installer writes AGENTS.md if absent; it overwrites only when you pass --yes.

How To Use With Cursor

  • Open your project in Cursor. Rules under .cursor/rules are discovered automatically by Cursor.
  • Keep this AGENTS.md handy as your quick index to the rule set.
  • For installation methods and advanced options, see README.md.

Installation Options

For full installation details and examples, see README.md.

  • Core rules only: --core
  • Web stack (includes core): --web-stack or --ws
  • Python (includes core): --python
  • JavaScript security (includes core): --javascript
  • All rules: --all
  • Tag-based selection: --tags "<expression>" or --tag-preset <name>
  • Ignore files control: --ignore-files yes|no|ask

Tag taxonomy is documented in TAG_STANDARDS.md.

Rule Bundles (Source of Truth)

Below are the rule bundles and their rule files. Each item links directly to the authoritative file under .cursor/rules/.

Core

Web Stack

Python

JavaScript Security

Tag-Based Selection

The installer supports tag expressions and presets. Examples:

  • --tags "language:javascript category:security"
  • --tags "framework:react"
  • --tags "language:php standard:owasp-top10"
  • --tag-preset js-owasp

See TAG_STANDARDS.md for the complete tag taxonomy and guidance.

Maintainer Checklist

  • Before opening a pull request, prepend a new entry to CHANGELOG.md describing your changes (latest release first) and never delete prior history.
  • Ensure the summary in CHANGELOG.md matches the work being done and that CURSOR_RULES_VERSION reflects the next release number.
  • Record key implementation notes in this AGENTS.md only when they affect installer behaviour or rule coverage so the instructions stay current.
  • Regenerate project-local AGENTS.md files with --yes when you need to refresh them after significant rule or command updates.

Updating Or Removing

  • To update, re-run the installer with your preferred options (it will copy over updated rules). See README.md.
  • To remove rules, delete files from .cursor/rules and remove any generated .cursorignore files if not needed.

References