Made with ❤️ in Cursor IDE, dogfooding
cursor-rules
A CLI tool for managing AI-assisted guidance in your projects through Cursor IDE rules.
Cursor rules are markdown files with structured metadata that provide AI with instructions on how to interact with your codebase. These rules enhance the AI's understanding of:
- Project structure and organization
- Coding conventions and patterns
- Task management approaches
- Best practices specific to your codebase
- 🚀 Rule Installation: Easily add Cursor rules to any project
- 📋 Template Rules: Includes default rule templates for common use cases
- 💬 Interactive Setup: Guided setup process using command-line prompts
- 📊 Repomix Integration: Generate repository overviews using Repomix for AI analysis
- 📁 Project Structure: Creates standardized rule organization
# 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# Initialize cursor rules
cursor-rules init
# Generate repomix file
cursor-rules repomix
# Initialize and generate repomix
cursor-rules init -r
# Force overwrite existing rules
cursor-rules init -f
# List existing rules
cursor-rules list
# Display version or help
cursor-rules --version
cursor-rules --helpWhen you initialize cursor rules, the CLI will:
- Create a
.cursor/rulesdirectory in your project - Add default rule templates
- Guide you through customization
- cursor-rules.md: Guidelines for adding and organizing AI rules
- project-structure.md: Overview of project structure and organization
- task-list.md: Framework for tracking project progress
For more detailed documentation, visit:
- Idea inspired by Elie Steinbock OSS Cursor rules announcement
- Codebase inspired from and using repomix
MIT