JSPM

  • Created
  • Published
  • Downloads 12
  • Score
    100M100P100Q96266F
  • License ISC

Bootstrap of **Cursor** rules (`.mdc`) and mirror documentation (`.md`) for AI agent-guided projects.

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

    Agent Rules Kit Logo

    Bootstrap of Cursor rules (.mdc) and mirror documentation (.md) for AI agent-guided projects.

    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.

    🎉 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)
    • Angular (v14-17)
    • NestJS
    • Vue (v2-3)
    • Nuxt (v2-3)
    • Astro
    • Generic (for any project)

    Implementation Status

    Stack Status Features
    Laravel 95% Multiple architectures, version detection, casting rules
    Next.js 85% App & Pages router support, version detection, testing docs
    Angular 55% Signals support, base project structure
    NestJS 45% Base project structure, patterns documentation
    React 85% Architecture options, state management, testing guidelines
    Vue 45% Testing guidelines, architecture concepts
    Nuxt 40% Testing guidelines, architecture concepts
    Astro 20% Basic configuration
    Generic 100% Best practices, file operations, code standards, extensibility docs

    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.

    Installation

    No installation needed, run directly with:

    npx agent-rules-kit
    # or
    pnpx agent-rules-kit