You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Rulefy is a Node.js tool that transforms GitHub repositories into [Cursor](https://cursor.sh/) rules instructions in a markdown file. It leverages [repomix](https://github.com/yamadashy/repomix) for repository-to-text conversion and integrates with cursor rules guidelines to guide LLM generation.
7
+
**Supercharge your Cursor AI with codebase-specific intelligence.** Rulefy transforms your GitHub repositories into custom rules that teach Cursor AI how your project works, resulting in more accurate code suggestions, better refactoring, and contextually aware assistance.
8
+
9
+
## Why Rulefy?
10
+
11
+
- ✅ **Instant Expertise**: Your AI assistant immediately understands your project conventions and architecture
12
+
- ✅ **Better Suggestions**: Get code completions that match your project's style and patterns
13
+
- ✅ **Fewer Hallucinations**: Rules constrain the AI to work within your codebase's patterns and dependencies
14
+
- ✅ **Zero Learning Curve**: One command to analyze your repo and generate optimized rules
15
+
8
16
9
17
## Features
10
18
11
-
- 🚀 Analyze GitHub repositories or local codebases
12
-
- 🧩 Convert codebase structure to LLM-friendly format
19
+
- 🚀 Analyze GitHub repositories or local codebases with a single command
20
+
- 🧩 Intelligently extract project structure, conventions, and patterns
13
21
- 🤖 Generate tailored Cursor rules using Claude AI
14
-
- 📝 Create customized .rules.mdc files for Cursor editor
15
-
- 🔧 Easily configurable through CLI options
22
+
- 📝 Create production-ready .rules.mdc files for immediate use
23
+
- 🔧 Customize analysis with flexible configuration options
16
24
17
25
## Installation
18
26
@@ -47,9 +55,6 @@ Examples:
47
55
# Using GitHub URL
48
56
rulefy https://github.com/fastapi/fastapi
49
57
50
-
# Using GitHub shorthand
51
-
rulefy fastapi/fastapi
52
-
53
58
# Using local repository path
54
59
rulefy ./my-local-project
55
60
```
@@ -60,6 +65,18 @@ This will:
60
65
3. Generate cursor rules using Claude Sonnet 3.5
61
66
4. Save the output to a `<repo-name>.rules.mdc` file
62
67
68
+
69
+
## Installing Rules in Cursor
70
+
71
+
After generating your rules file, you'll need to install it in Cursor:
72
+
73
+
1. Open Cursor editor
74
+
2. Go to Settings > AI > Rules
75
+
3. Click "Add Rules File" and select your generated `.rules.mdc` file
76
+
4. Restart Cursor to apply the new rules
77
+
78
+
For more detailed instructions, see the [official Cursor documentation](https://docs.cursor.com/context/rules-for-ai).
79
+
63
80
### Options
64
81
65
82
```
@@ -75,7 +92,7 @@ Options:
75
92
76
93
1.**Repository Conversion**: Uses repomix to convert GitHub repositories into a textual representation
77
94
2.**Guidelines Integration**: Reads cursor rules guidelines from the specified file
78
-
3.**LLM Generation**: Passes the repository content and guidelines to Claude Sonnet 3.5
95
+
3.**LLM Generation**: Passes the repository content and guidelines to LLM
79
96
4.**Output**: Saves the generated cursor rules to a markdown file
80
97
81
98
## Example Output
@@ -102,6 +119,13 @@ This project is a TypeScript application that...
102
119
103
120
Contributions are welcome! Please feel free to submit a Pull Request.
104
121
105
-
## License
106
122
107
-
MIT
123
+
## Acknowledgements
124
+
125
+
This project is inspired by and builds upon the work of:
126
+
127
+
-[repomix](https://github.com/yamadashy/repomix) - A tool for converting repositories into textual representations
128
+
-[awesome-cursorrules](https://github.com/PatrickJS/awesome-cursorrules) - A curated list of cursor rules for different projects and languages
129
+
130
+
We're grateful to these projects for their contributions to the developer tooling ecosystem.
0 commit comments