Cursor Rules CLI
Disclaimer: This project is not officially associated with or endorsed by Cursor. It is a community-driven initiative to enhance the Cursor experience.
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
Metadata
Release files for cursor-rules 0.5.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| cursor_rules-0.5.1.tar.gz | 29.0 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| cursor_rules-0.5.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 57.5 kB
Release files / cursor_rules-0.5.1.tar.gz
| Download URL | cursor_rules-0.5.1.tar.gz |
|---|---|
| Size | 29.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
27087383cf891fb7ab2e893558e7d3518da90e9fde547c4dbade7218d289a0a9
|
|
BLAKE2b-256 checksum How to use checksums |
73b2ad6d82898c7f2210f1df303a5996709c86a5c676cf2ad55332f1278da6cb
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.11.9
|
Release files / cursor_rules-0.5.1-py3-none-any.whl
| Download URL | cursor_rules-0.5.1-py3-none-any.whl |
|---|---|
| Size | 28.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
492bbadbabfb5e48f2e738f7d8c19efc0bada6b90e2454c1ca6ae1cf484b2e1b
|
|
BLAKE2b-256 checksum How to use checksums |
3e09274ada5b60e0954bb8101de69b9f564175cecd57527c90f4483a67503bbd
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.11.9
|