Cursor Project Rules

Local Documentation for AI-Assisted Development

Supercharge your Cursor AI with up-to-date, local documentation

Get Started »

Available Rules · Usage · Contributing · Changelog · Report Bug

📚 About

Cursor Project Rules is a collection of local documentation that instructs the Cursor AI on how to work efficiently with modern frameworks and libraries. Unlike web-scraped documentation that might be outdated or incomplete, these rules provide Cursor's AI with accurate, comprehensive, and immediately accessible information.

Why Local Documentation?

Performance: No need to wait for web scraping or API calls
Accuracy: Carefully curated information without HTML parsing errors
Completeness: Full documentation coverage without token limitations
Reliability: Works even without internet connection

✨ Available Rules

This repository includes documentation for:

Rule	Description
AI SDK	Complete guides for using the Vercel AI SDK with various LLM providers
OpenAI	Comprehensive documentation for the OpenAI API integration
Google Generative AI	Full guides for Google's Generative AI models and API
Clerk	Authentication and user management best practices
Schematic	Payment API integration and implementation
Shadcn/UI	Component installation and usage patterns
TailwindCSS v4	Latest Tailwind CSS client-side implementation
Convex	Complete guide for Convex database and backend services
Polar	Documentation for Polar payment integration and implementation

🚀 Getting Started

Prerequisites

Cursor Editor installed on your machine
A project where you want to use the AI assistance

Installation

Clone this repository to your local machine:

hljs language-bash

git clone https://github.com/yourusername/cursor-project-rules.git

Copy the .cursor folder to your project:

hljs language-bash

cp -r cursor-project-rules/.cursor /path/to/your/project/

Restart Cursor or reload your project

🔍 Usage

Once installed, the Cursor AI will automatically have access to these rules. You can:

Ask the AI to implement features using specific frameworks
Request the AI to follow best practices from the documentation
Get guidance on implementation details without relying on web lookups

Example Commands

hljs language-arduino

"Create a login form using Clerk authentication"
"Set up an AI chat interface using the AI SDK with OpenAI provider"
"Implement a payment form with Schematic"
"Add a shadcn/ui dropdown component"
"Set up a Convex database and add CRUD operations"
"Implement subscription payments with Polar"

🤝 Contributing

We welcome contributions to improve and expand these documentation rules! See CONTRIBUTING.md for details on how to add or update rules.

📋 License

This project is licensed under the MIT License - see the LICENSE file for details.

🙏 Acknowledgments

Cursor for creating an amazing AI-powered editor
The developers of all the documented libraries and frameworks
Contributors who help maintain and expand this documentation

Made with ❤️ for the Cursor community

cursor-project-rules