cursor-rules

Made with ❤️ in Cursor IDE, dogfooding cursor-rules

A command-line tool for managing AI-assisted guidance in your projects through Cursor IDE rules.

What are Cursor Rules?

Cursor rules are markdown files with structured metadata that provide AI with instructions on how to interact with your codebase. These rules help the AI understand project structure, coding conventions, and best practices specific to your codebase.

Installation

- global install

bun

bun add -g @gabimoncha/cursor-rules

yarn

yarn global add @gabimoncha/cursor-rules

npm

npm install -g @gabimoncha/cursor-rules

- project install

bun

bun add -d @gabimoncha/cursor-rules

yarn

yarn add -D @gabimoncha/cursor-rules

npm

npm install --save-dev @gabimoncha/cursor-rules

Usage

- init cursor rules

cursor-rules --init

This will:

1. Create a .cursor/rules directory in your project
2. Add default rule templates (cursor-rules.md, project-structure.md, task-list.md)
3. Guide you through customizing these templates for your project

- generate repomix file to be used with AI

cursor-rules --repomix

- available commands

# Show help information
cursor-rules --help

# Display the current version
cursor-rules --version

# List existing rules
cursor-rules --list

# Force overwrite existing rules
cursor-rules --force

# Initialize with verbose output
cursor-rules --init --verbose

Default Rule Templates

The CLI provides three default rule templates:

• cursor-rules.md: Guidelines for adding and organizing AI rules in your project
• project-structure.md: Overview of your project's structure and organization
• task-list.md: Framework for tracking project progress with markdown task lists

Documentation

For more detailed documentation, visit:

• Cursor Rules Guide
• CLI Commands
• Contributing Guide

Acknowledgements

Idea inspired by Elie Steinbock OSS Cursor rules announcement

License

MIT