A CLI tool to scan projects and install relevant Cursor rules
Project description
Cursor Rules CLI
A simple tool that helps you find and install the right Cursor rules for your project. It scans your project to identify libraries and frameworks you're using and suggests matching rules.
Features
- 🔍 Auto-detects libraries in your project
- 📝 Supports direct library specification
- 📥 Downloads and installs rules into Cursor
- 🎨 Provides a colorful, user-friendly interface
- 🔀 Works with custom rule repositories
- 🔒 100% privacy-focused (all scanning happens locally)
Installation
pip install cursor-rules
Basic Usage
# Scan current project and install matching rules
cursor-rules
# Specify libraries directly (skips project scanning)
cursor-rules --libraries "react,tailwind,typescript"
# Scan a specific project directory
cursor-rules -d /path/to/my/project
Common Options
| Option | Description |
|---|---|
--dry-run |
Preview without installing anything |
--force |
Replace existing rules |
-v, --verbose |
Show detailed output |
--quick-scan |
Faster scan (checks package files only) |
--max-results N |
Show top N results (default: 20) |
Custom Repositories (not tested yet)
# Use rules from your own repository
cursor-rules --custom-repo your-username/your-repo
# Save repository setting for future use
cursor-rules --custom-repo your-username/your-repo --save-config
Configuration
# View current settings
cursor-rules --show-config
# Save settings globally
cursor-rules --save-config
# Save settings for current project only
cursor-rules --save-project-config
Full Options Reference
Run cursor-rules --help to see all available options.
License
MIT
Todo:
- Test the custom repo feature
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file cursor_rules-0.5.0.tar.gz.
File metadata
- Download URL: cursor_rules-0.5.0.tar.gz
- Upload date:
- Size: 32.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.12.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
78046640936090c5501de45ed7e15643cb8e0d3702f0daad711ed129f19df20b
|
|
| MD5 |
533728abaef79c6293d3e8c2e5f79a8c
|
|
| BLAKE2b-256 |
c85d85ddc53eb9e893bcbeb249c72c57386deb16d6f1d14a7475eafd417fee1e
|
File details
Details for the file cursor_rules-0.5.0-py3-none-any.whl.
File metadata
- Download URL: cursor_rules-0.5.0-py3-none-any.whl
- Upload date:
- Size: 32.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.12.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
e9feb26ac89706fc8e20239cf7e0891855eb1a9a6c7d7f691448fb710aea2547
|
|
| MD5 |
89a37a1971e56427afee9e4cc70ada01
|
|
| BLAKE2b-256 |
a73573b90af1b306c70d8229ec61e1e32a3dcf954d118e896881542a761181b8
|