Cursor Rules Deploy 🚀

🎯 A powerful CLI tool that supercharges your Cursor AI development workflow by managing and deploying custom rules and templates.

📢 Important Notice

This CLI tool is designed to complement and leverage the excellent work from BMad's Cursor Custom Agents Rules Generator. We extend our heartfelt gratitude to BMad for their outstanding contributions to the Cursor AI community through their comprehensive framework for custom agents and rules generation.

This tool serves as a deployment utility to help you better utilize BMad's methodologies and best practices. While our tool focuses on the deployment aspects, we strongly encourage you to explore BMad's original repository for in-depth understanding of:

• Custom Agent Generation
• Rule Management Best Practices
• Agile Workflow Integration
• Advanced AI Behavior Control

🙏 Special thanks to BMad for pioneering these concepts and making them available to the community!

✨ Features

• 🔄 Easy Setup: Get started in seconds with a simple CLI interface
• 📦 Template Management: Create and manage reusable code templates
• 🎨 Custom Rules: Define and deploy AI behavior rules effortlessly
• 🚀 Quick Deployment: Deploy your rules and templates with a single command
• 🔍 Smart Validation: Built-in validation ensures your rules are correctly formatted
• 📚 Rich Documentation: Comprehensive guides and examples included

🛠 Requirements

• Node.js >= 22.14.0
• Cursor AI installed on your system

📥 Installation & Usage

Using npx (Recommended)

npx cursor-rules-deploy my-rules-project

Alternative Package Managers

Using yarn

yarn dlx cursor-rules-deploy my-rules-project

Using pnpm

pnpm dlx cursor-rules-deploy my-rules-project

Using cnpm

cnpm dlx cursor-rules-deploy my-rules-project

Note

• Each command above will download and execute the latest version of cursor-rules-deploy
• The tool will create a new rules project in the my-rules-project directory

🌟 Show Your Support

If you find this tool helpful, please consider giving it a star on GitHub! It helps make the project more visible and encourages further development.

⭐ Star History

🤝 Contributing

We welcome contributions! Please see our Contributing Guide for details.

1. Fork the repository
2. Create your feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add some amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

📝 License

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

📫 Contact

• GitHub Issues: cursor-rules-deploy/issues
• Author: rosendolu