Cursorifier

# Cursorifier

<div align="center">

[![npm version](https://img.shields.io/npm/v/cursorifier.svg?style=for-the-badge)](https://www.npmjs.com/package/cursorifier)
[![npm downloads](https://img.shields.io/npm/dm/cursorifier.svg?style=for-the-badge)](https://www.npmjs.com/package/cursorifier)
[![GitHub stars](https://img.shields.io/github/stars/rainmana/cursorifier.svg?style=for-the-badge&label=Stars)](https://github.com/rainmana/cursorifier)
[![GitHub forks](https://img.shields.io/github/forks/rainmana/cursorifier.svg?style=for-the-badge&label=Forks)](https://github.com/rainmana/cursorifier)
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg?style=for-the-badge)](https://opensource.org/licenses/MIT)
[![Node.js Version](https://img.shields.io/node/v/cursorifier.svg?style=for-the-badge)](https://nodejs.org/)

[![GitHub stars over time](https://starchart.cc/rainmana/cursorifier.svg)](https://starchart.cc/rainmana/cursorifier)

</div>

**Supercharge your Cursor AI with codebase-specific intelligence.** Cursorifier 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. Now supports multiple LLM providers including Anthropic Claude, OpenAI, and local models like Ollama.

## Why Cursorifier?

- ✅ **Instant Expertise**: Your AI assistant immediately understands your project conventions and architecture
- ✅ **Better Suggestions**: Get code completions that match your project's style and patterns
- ✅ **Fewer Hallucinations**: Rules constrain the AI to work within your codebase's patterns and dependencies
- ✅ **Zero Learning Curve**: One command to analyze your repo and generate optimized rules


## Features

- 🚀 Analyze GitHub repositories or local codebases with a single command
- 🧩 Intelligently extract project structure, conventions, and patterns
- 📚 Handles large codebases that exceed the token limit for LLMs
- 🤖 Generate tailored rules for both **Cursor AI** and **Cline** using multiple LLM providers
- 🔌 **Multi-Provider Support**: Anthropic Claude, OpenAI, Ollama, LM Studio, and more
- 🏠 **Local AI Support**: Use your own models with Ollama or LM Studio
- 📝 Create production-ready `.rules.mdc` files for Cursor AI
- 📋 Create `.clinerules` files for Cline AI assistant
- 🔧 Customize analysis with flexible configuration options

## 🚀 Installation

### Quick Install (Recommended)

```bash
# Install globally from npm
npm install -g cursorifier

# Or use with npx (no installation required)
npx cursorifier
```

### Alternative Installation Methods

```bash
# Install from GitHub (latest development version)
npm install -g https://github.com/rainmana/cursorifier.git

# Or clone and install locally
git clone https://github.com/rainmana/cursorifier.git
cd cursorifier
npm install
npm link
```

### Verify Installation

```bash
cursorifier --version
cursorifier --list-providers
```

📦 **Available on [npmjs.com](https://www.npmjs.com/package/cursorifier)**

## 🎬 Quick Demo

```bash
# Generate rules for any GitHub repository
cursorifier https://github.com/facebook/react

# Use with local models (Ollama)
cursorifier . --provider local --base-url http://localhost:11434 --model llama2

# Use existing repomix output
cursorifier --repomix-file ./my-repo-analysis.xml
```

## 🎯 Output Formats

Cursorifier supports two AI assistant formats:

### **Cursor AI Rules** (Default)
```bash
# Generate Cursor AI rules
cursorifier https://github.com/facebook/react
# Output: react-output/react.rules.mdc
```

**Features:**
- `.rules.mdc` file format with FrontMatter
- AI behavior instructions and patterns
- Glob patterns for file targeting
- Always/Manual/Auto rule types

### **Cline Rules**
```bash
# Generate Cline rules
cursorifier https://github.com/facebook/react --output-format cline
# Output: react-output/.clinerules
```

**Features:**
- `.clinerules` file format
- Project guidelines and coding standards
- Team consistency and best practices
- Focus on development workflow

### **Roo Custom Modes**
```bash
# Generate Roo Custom Modes
cursorifier https://github.com/facebook/react --output-format roo
# Output: react-output/.roomodes
```

**Features:**
- `.roomodes` YAML configuration file
- Specialized AI personas for different tasks
- Tool access permissions and file restrictions
- Custom behavioral instructions
- Mode-specific expertise and capabilities

## 🛡️ Reliability Features

### **Automatic Rate Limit Handling**
- **Smart Retries**: Automatically retries on rate limits with exponential backoff (2s, 4s, 8s)
- **Configurable Delays**: Control chunk processing speed with `--chunk-delay`
- **Progress Tracking**: Clear feedback on retry attempts and delays

### **Robust Text Processing**
- **Token Sanitization**: Automatically removes problematic tokens like `<|endoftext|>`
- **Large Repository Support**: Handles repositories with millions of tokens
- **Chunk Processing

... (truncated)