Skip to content

Commit e11b7a6

Browse files
author
nik
committed
Update the code, add ack
1 parent 184f01b commit e11b7a6

File tree

7 files changed

+631
-54027
lines changed

7 files changed

+631
-54027
lines changed

README.md

Lines changed: 35 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,23 @@
44
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
55
[![Node.js Version](https://img.shields.io/node/v/rulefy.svg)](https://nodejs.org/)
66

7-
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+
816

917
## Features
1018

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
1321
- 🤖 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
1624

1725
## Installation
1826

@@ -47,9 +55,6 @@ Examples:
4755
# Using GitHub URL
4856
rulefy https://github.com/fastapi/fastapi
4957

50-
# Using GitHub shorthand
51-
rulefy fastapi/fastapi
52-
5358
# Using local repository path
5459
rulefy ./my-local-project
5560
```
@@ -60,6 +65,18 @@ This will:
6065
3. Generate cursor rules using Claude Sonnet 3.5
6166
4. Save the output to a `<repo-name>.rules.mdc` file
6267

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+
6380
### Options
6481

6582
```
@@ -75,7 +92,7 @@ Options:
7592

7693
1. **Repository Conversion**: Uses repomix to convert GitHub repositories into a textual representation
7794
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
7996
4. **Output**: Saves the generated cursor rules to a markdown file
8097

8198
## Example Output
@@ -102,6 +119,13 @@ This project is a TypeScript application that...
102119

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

105-
## License
106122

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.
131+

0 commit comments

Comments
 (0)