Package Exports

@gabimoncha/cursor-rules
@gabimoncha/cursor-rules/lib/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@gabimoncha/cursor-rules) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

cursor-rules

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

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

What are Cursor Rules?

YouTube presentation

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

Features

🚀 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

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

# 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 --help

When you initialize cursor rules, the CLI will:

Create a .cursor/rules directory in your project
Add default rule templates
Guide you through customization

Default Rule Templates

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

Documentation

For more detailed documentation, visit:

Acknowledgements

Idea inspired by Elie Steinbock OSS Cursor rules announcement
Codebase inspired from and using repomix

License

MIT