Package Exports
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (agent-rules-kit) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
Agent Rules Kit v1
Bootstrap Cursor rules (
.mdc
) for AI agent-guided projects. This tool helps you generate and maintain project-specific rules for multiple frameworks and architectures.
What is Agent Rules Kit?
Agent Rules Kit is a CLI tool that facilitates the installation and configuration of rules for Cursor AI, the AI-powered IDE. The rules help AI agents better understand the structure, patterns, and best practices of different technology stacks.
🎧 Audio Introduction
Listen to a brief introduction about Agent Rules Kit:
https://github.com/user-attachments/assets/7d65c696-245d-421d-9ddc-90331a92c9b2
https://github.com/user-attachments/assets/8e91d651-c15f-4892-a250-684ab60d8594
📚 Table of Contents
- Quick Start
- New Architecture
- New Features
- Supported Stacks
- Implementation Status
- Contributing
- Code of Conduct
- License
🚀 Quick Start
Installation
Option 1: Run directly (Recommended)
No installation needed, run directly with:
npx agent-rules-kit
# or
pnpx agent-rules-kit
Option 2: Global installation
npm install -g agent-rules-kit
# Then run
agent-rules-kit
Option 3: Development/Contribution
git clone https://github.com/tecnomanu/agent-rules-kit.git
cd agent-rules-kit
pnpm install
pnpm start
Basic Usage
Run the command in your project root:
npx agent-rules-kit
Follow the interactive instructions to select the stack, architecture, and other options.
Available Options
- Stack Selection: Choose the main framework or technology for your project
- Global Rules: Include general best practice rules
- Cursor Directory: Specify the location of the Cursor directory
- Project Path: Define the relative path if the project is not in the root
- Mirror Documentation: Generate .md files that reflect the rules for human reference
- Debug Mode: Enable detailed logging for troubleshooting
🎉 New Architecture
We've completely redesigned the internal architecture to provide a more maintainable and extensible system:
- Service-Based Architecture: Replaced the helper-based system with a clean service-oriented architecture that enhances maintainability and extensibility
- Automatic Backups: Smart backup system that preserves your custom rules when updating
- Enhanced Debug Mode: Better visibility into the rule generation process with standardized logging
- Improved Testing Framework: More robust testing with better mocking and service isolation
- React Architecture Options: Now includes support for atomic design and feature-sliced design
- Better State Management Support: Enhanced support for modern state management libraries
🎉 New Features
- 🚀 Quick setup of rules for different frameworks and stacks
- 🔍 Automatic framework version detection
- 🏗️ Support for multiple architectural styles
- 📚 Mirror documentation generation for human reference
- 🧩 Modular system for easy expansion to new frameworks
- 💾 Automatic backups of existing rules
- 🔄 Version-specific rule overlays
Supported Stacks
- Laravel (v8-12)
- Next.js (v12-14)
- React (v17-18)
- React Native
- Angular (v14-17)
- NestJS
- Vue (v2-3)
- Nuxt (v2-3)
- Svelte (v3-5)
- SvelteKit (v1-2)
- Astro
- Generic (for any project)
Implementation Status
Stack | Status | Features |
---|---|---|
Multiple architectures, version detection, casting rules | ||
Testing guidelines, architectural patterns, version-specific docs | ||
Best practices, file operations, code standards, extensibility docs | ||
Architecture options, state management, testing guidelines, version-specific guidance (v18 concurrent features) | ||
Base rules (architecture, best practices, styling, naming, navigation, platform code, state, testing, version info) | ||
App & Pages router support, version detection, testing docs, version-specific guidance (v13 API routes, v14 Server Components) | ||
Component organization, runes (v5), lifecycle, state management | ||
Multiple architectures, project structure, error handling patterns | ||
Routing system, layouts, SSR/CSR strategies, form actions | ||
Content collections, static/dynamic content, integration guides | ||
Signals support, base project structure | ||
Standard and Microservices architectures, NestJS 9.x and 10.x features | ||
Testing guidelines, architecture concepts |
Enhanced Extensibility: Detailed documentation has been added on how to extend Agent Rules Kit with new services, making it easier to contribute new stacks and features.
Contributing
For guidelines on contributing to this project, please see CONTRIBUTING.md.
Code of Conduct
Please read our Code of Conduct before participating in our project.
License
This project is licensed under the ISC License. See the LICENSE file for details.