ai-rulez 2.4.3 → 3.0.0

package/README.md

@@ -1,10 +1,10 @@
-# ai-rulez ⚡
+# ai-rulez
 
 <p align="center">
   <img src="https://raw.githubusercontent.com/Goldziher/ai-rulez/main/docs/assets/logo.png" alt="ai-rulez logo" width="200" style="border-radius: 15%; overflow: hidden;">
 </p>
 
-**AI-powered development governance. One config to rule them all.**
+Directory-based AI governance for development teams.
 
 [![Go Version](https://img.shields.io/badge/Go-1.24%2B-00ADD8)](https://go.dev)
 [![NPM Version](https://img.shields.io/npm/v/ai-rulez)](https://www.npmjs.com/package/ai-rulez)
@@ -15,142 +15,86 @@
 
 ---
 
-## Why ai-rulez
+## What is ai-rulez?
 
-- One YAML file stays in sync with every AI assistant format (`CLAUDE.md`, `.cursorrules`, `.windsurfrules`, MCP configs, and more).
-- AI agents enforce your rules in real time with optional auto-fix and review loops.
-- Git hooks, CI, and MCP integrations keep governance in every stage of your workflow.
-- Works for individuals and teams with presets, remote includes, and monorepo support.
+ai-rulez organizes your AI assistant rules, context, and domain-specific guidance in a single `.ai-rulez/` directory. Write once, generate native configurations for Claude, Cursor, Windsurf, Copilot, Gemini, and more.
 
-<p align="center">
-  <img src="docs/assets/ai-rulez-python-demo.gif" alt="AI-Rulez Configuration Demo" width="90%">
-</p>
+**Key features:**
+- **Directory-based** – One `.ai-rulez/` directory for all your AI tooling
+- **Multi-tool generation** – Generate configs for all major AI assistants from one source
+- **Domain separation** – Organize rules by backend, frontend, QA, or any domain
+- **Profiles** – Define profiles for different teams or use cases
+- **Includes** – Compose from local packages or Git repositories
+- **CRUD operations** – Manage configuration programmatically via CLI or MCP
 
 ---
 
-## What You Get
+## Installation
 
-- **Universal configuration management** – `ai-rulez` analyzes your repo and generates native configuration files for every assistant.
-- **AI-powered enforcement** – Run `ai-rulez enforce` to catch violations, apply fixes, and gate merges with configurable quality thresholds.
-- **Automation built-in** – Smart `.gitignore` updates, Git hook integration (lefthook, pre-commit, husky), and CI ready commands.
-- **MCP everywhere** – Automatically wire MCP servers into Claude CLI, Gemini CLI, Cursor, and other supported tools.
-
----
-
-## Quick Start
-
-### Configuration Management
+### Quick Start (No Installation)
 
+**npm:**
 ```bash
-# Analyze your project and scaffold configuration
-npx ai-rulez@latest init "My Project" --preset popular
-
-# Generate all assistant configuration files
-npx ai-rulez@latest generate
+npx ai-rulez@latest init "My Project"
 ```
 
-### Rule Enforcement
-
+**uv:**
 ```bash
-# Check for violations (read-only)
-uvx ai-rulez@latest enforce --agent claude
-
-# Apply fixes or run multi-agent reviews
-uvx ai-rulez@latest enforce --agent claude --fix
-uvx ai-rulez@latest enforce --agent gemini --review --review-iterations 2
+uvx ai-rulez init "My Project"
 ```
 
-### Optional: Auto-Configure Git Hooks
+### Global Installation
 
+**Homebrew (macOS/Linux):**
 ```bash
-# Detect pre-commit, lefthook, or husky and add ai-rulez validation
-npx ai-rulez@latest init --setup-hooks
+brew install goldziher/tap/ai-rulez
 ```
 
-`--setup-hooks` adds the official hooks for the detected system and keeps existing configuration intact.
-
----
-
-## Example `ai-rulez.yaml`
-
-```yaml
-$schema: https://github.com/Goldziher/ai-rulez/schema/ai-rules-v2.schema.json
-
-metadata:
-  name: "My SaaS Platform"
-
-presets:
-  - "popular"  # Claude, Cursor, Windsurf, Copilot, Gemini
-
-rules:
-  - name: "Go Code Standards"
-    priority: high
-    content: "Follow standard Go project layout and export only what is necessary."
+**Go:**
+```bash
+go install github.com/Goldziher/ai-rulez/cmd@latest
+```
 
-sections:
-  - name: "Project Structure"
-    priority: critical
-    content: |
-      - `cmd/`: Main application entry point
-      - `internal/`: Private application code
-      - `pkg/`: Public-facing libraries
+**npm (Node.js):**
+```bash
+npm install -g ai-rulez
+```
 
-agents:
-  - name: "go-developer"
-    description: "Expert Go developer focused on idiomatic code and tests."
+**uv (Python):**
+```bash
+uv tool install ai-rulez
+```
 
-mcp_servers:
-  - name: "ai-rulez"
-    command: "npx"
-    args: ["-y", "ai-rulez@latest", "mcp"]
-    description: "Configuration management server"
+**pip (Python):**
+```bash
+pip install ai-rulez
 ```
 
 ---
 
-## Installation Options
+## Quick Example
 
-- **No install required**  
-  - `npx ai-rulez@latest ...` for Node/JS environments  
-  - `uvx ai-rulez@latest ...` for Python users  
-  - `go run github.com/Goldziher/ai-rulez/cmd@latest ...` for Go projects
-- **Global installs**  
-  - `brew install goldziher/tap/ai-rulez`  
-  - `npm install -g ai-rulez`  
-  - `pip install ai-rulez`  
-  - `go install github.com/Goldziher/ai-rulez/cmd@latest`
-
----
-
-## Git Hooks & Automation
+```bash
+# Initialize a new project
+ai-rulez init "My Project" --preset claude
 
-- **Official pre-commit hooks**
+# Add a rule
+ai-rulez add rule coding-standards --priority high
 
-  ```yaml
-  repos:
-    - repo: https://github.com/Goldziher/ai-rulez
-      rev: v2.4.3
-      hooks:
-        - id: ai-rulez-validate
-        - id: ai-rulez-generate
-  ```
+# Generate configs for all tools
+ai-rulez generate
+```
 
-- **CLI hook setup** – Run `ai-rulez init --setup-hooks` to auto-configure pre-commit, lefthook, or husky if they are present in your repo.
-- **No-Go requirement** – Hooks use `scripts/pre-commit/run-ai-rulez.sh`, which fetches the correct prebuilt binary on-demand (override with `AI_RULEZ_BINARY` if you already have one installed).
-- **CI/CD examples** – See the [Enforcement guide](https://goldziher.github.io/ai-rulez/enforcement/) for GitHub Actions, pipeline tips, and advanced workflows.
+This creates `CLAUDE.md`, `.cursorrules`, and other native configs from your `.ai-rulez/` directory.
 
 ---
 
-## More to Explore
+## Learn More
 
-- [Quick Start](https://goldziher.github.io/ai-rulez/quick-start/) – Guided setup in minutes.
-- [CLI Reference](https://goldziher.github.io/ai-rulez/cli/) – All commands and flags.
-- [Configuration Guide](https://goldziher.github.io/ai-rulez/configuration/) – Advanced YAML features, includes, and presets.
-- [Enforcement Guide](https://goldziher.github.io/ai-rulez/enforcement/) – Multi-agent reviews, automation, and reporting.
-- [Migration Guide](https://goldziher.github.io/ai-rulez/migration-guide/) – Upgrading from v1.x.
+**[Full Documentation →](https://goldziher.github.io/ai-rulez/)**
 
 ---
 
 ## Contributing
 
-We welcome contributions! Read the [CONTRIBUTING.md](CONTRIBUTING.md) for development setup, coding standards, and release process details.
+We welcome contributions! Read [CONTRIBUTING.md](CONTRIBUTING.md) for development setup and guidelines.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ai-rulez",
-  "version": "2.4.3",
+  "version": "3.0.0",
   "description": "⚡ One config to rule them all. Centralized AI assistant configuration management - generate rules for Claude, Cursor, Copilot, Windsurf and more from a single YAML file.",
   "keywords": [
     "ai",