cursor-rules

Crates.iocursor-rules
lib.rscursor-rules
version0.1.2
created_at2025-06-11 21:55:21.51837+00
updated_at2025-06-15 02:57:32.730262+00
descriptionA CLI tool for managing Cursor rules from GitHub repositories
homepagehttps://github.com/tkozzer/cursor-rules-cli
repositoryhttps://github.com/tkozzer/cursor-rules-cli
max_upload_size
id1709161
size94,771
Tyler Kozlowski (tkozzer)

documentation

README

cursor-rules

Crate Documentation License: MIT

A CLI tool for managing Cursor rules from GitHub repositories.

Overview

cursor-rules is an interactive, cross-platform Rust CLI that allows developers to browse GitHub repositories named cursor-rules and copy selected .mdc rule files into their projects. It provides an easy way to share and manage Cursor IDE configuration rules across different projects.

Installation

From crates.io

cargo install cursor-rules

From source

git clone https://github.com/tkozzer/cursor-rules-cli.git
cd cursor-rules-cli
cargo install --path .

Usage

Basic Usage

# Interactive browse mode (default)
cursor-rules

# Browse a specific owner's repository
cursor-rules --owner myorg

# Quick-add a specific manifest
cursor-rules quick-add QUICK_ADD_ALL.txt --owner myorg

# List available rules
cursor-rules list --owner myorg

Commands

  • browse - Interactive browser (default)
  • quick-add <ID> - Apply a manifest (ID = filename or friendly slug)
  • list - Print repo tree in JSON/YAML
  • config - Show or modify saved config
  • cache - Manage offline cache (list|clear)
  • completions - Generate shell completions

Options

  • --owner, -o - GitHub owner to fetch rules from
  • --repo, -r - Repository name (defaults to 'cursor-rules')
  • --branch, -b - Branch to fetch from (defaults to 'main')
  • --out, -o - Output directory (defaults to './.cursor/rules')
  • --dry-run - Show what would be done without making changes
  • --force - Force overwrite without prompting
  • --verbose, -v - Verbose output

Repository Structure

Your cursor-rules repository should follow this structure:

cursor-rules/
├── frontend/
│   ├── react/
│   │   ├── react-core.mdc
│   │   └── tailwind.mdc
│   └── vue/
│       └── vue-core.mdc
├── backend/
│   └── rust/
│       └── actix.mdc
├── quick-add/
│   └── fullstack.txt
└── QUICK_ADD_ALL.txt

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Development Status

This is currently a barebones implementation. Full functionality is coming soon!

Current Version: 0.1.1 - Basic CLI structure only

Planned Features

  • Interactive repository browsing
  • Quick-add manifest support
  • GitHub authentication
  • Offline caching
  • Shell completions
  • And much more!

Stay tuned for updates!

Commit count: 37

cargo fmt