Agent Rules Kit v3.x

# Agent Rules Kit v3.x

<p align="center">
  <img src="assets/banner_agent_rules_kit.jpg" alt="Agent Rules Kit Logo" width="729" />
</p>

<p align="center">
  <img src="https://img.shields.io/npm/v/agent-rules-kit.svg" alt="Version" />
  <img src="https://img.shields.io/npm/dm/agent-rules-kit.svg" alt="Downloads" />
  <img src="https://img.shields.io/github/license/tecnomanu/agent-rules-kit" alt="License" />
  <img src="https://img.shields.io/github/last-commit/tecnomanu/agent-rules-kit" alt="Last Commit" />
  <img src="https://img.shields.io/github/actions/workflow/status/tecnomanu/agent-rules-kit/CI" alt="Build Status" />
</p>

<!-- Badges -->
<p align="center">
  <a href="#️-mcp">
    <img alt="MCP badge"
         src="https://img.shields.io/badge/Rules-MCP-6f42c1?style=for-the-badge&logo=sheriff"
    />
  </a>
  <a href="#️-stacks">
    <img alt="Stacks badge"
         src="https://img.shields.io/badge/Rules-Stacks-ff004c?style=for-the-badge&logo=layers"
    />
  </a>
  <a href="#️-globals">
    <img alt="Globals badge"
         src="https://img.shields.io/badge/Rules-Globals-0d6efd?style=for-the-badge&logo=files"
    />
  </a>
</p>

> CLI tool to bootstrap AI agent rules for multiple IDEs and frameworks. Generates optimized rules for Cursor, VS Code, Claude, and 6+ other AI coding assistants.

## 🎯 IDE Selection Interface

<p align="center">
  <img src="assets/terminal_select_ide.png" alt="Agent Rules Kit IDE Selector" width="800" />
</p>

_Choose from 9 supported IDEs including Cursor, VS Code/GitHub Copilot, Windsurf, Continue, Claude, and more._

## What is Agent Rules Kit?

Agent Rules Kit is a CLI tool that facilitates the installation and configuration of rules for multiple AI-powered IDEs and coding assistants. The rules help AI agents better understand the structure, patterns, and best practices of different technology stacks, generating optimized configurations for each supported IDE.

## 🎧 Audio Introduction

Listen to a brief introduction about Agent Rules Kit:

https://github.com/user-attachments/assets/7d65c696-245d-421d-9ddc-90331a92c9b2

[English Version](assets/podcast_en.mp3)

https://github.com/user-attachments/assets/8e91d651-c15f-4892-a250-684ab60d8594

[Spanish Version](assets/podcast_es.mp3)

## 📚 Table of Contents

1. [Quick Start](#-quick-start)
2. [New Architecture](#-new-architecture)
3. [New Features](#-new-features)
4. [Supported Stacks](#supported-stacks)
5. [MCP Tools Integration](#-mcp-tools-integration)
6. [Implementation Status](#implementation-status)
7. [Contributing](#contributing)
8. [Code of Conduct](#code-of-conduct)
9. [License](#license)

## 🚀 Quick Start

### Interactive Installation

```bash
# Install and run interactively
npx agent-rules-kit

# The CLI will guide you through:
# 1. 📁 Project path selection
# 2. 🎯 IDE selection (Cursor, VS Code, Claude, etc.)
# 3. 📚 Stack and architecture choice (optional)
# 4. 🌐 Global best practices (recommended)
# 5. 🔧 MCP tools selection (multiple tools supported)
# 6. ⚡ Automatic rule generation
```

### Command Line Installation

For automated or scripted installations, use command line arguments to skip interactive prompts:

```bash
# Basic installation with auto-detection
npx agent-rules-kit --stack=laravel --version=12 --global --auto-install

# Full configuration example
npx agent-rules-kit --stack=nextjs --version=14 --architecture=app --global --mcp-tools=pampa,github --ide=cursor

# For different IDEs
npx agent-rules-kit --stack=react --version=18 --ide=vscode    # VS Code
npx agent-rules-kit --stack=laravel --version=12 --ide=claude  # Claude
npx agent-rules-kit --stack=angular --version=17 --ide=windsurf # Windsurf
```

**📖 For complete CLI options and examples, see [AGENTS.md](AGENTS.md)**

Your rules will be generated in the appropriate location for your chosen IDE and automatically detected!

### AI Agent Integration

If you are using an AI agent, check [AGENTS.md](AGENTS.md) for comprehensive instructions on automated installation. Share this file with your agent so it installs the rules automatically with the correct 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**: 

... (truncated)