glooit 0.4.0

package/README.md

@@ -0,0 +1,144 @@
+# gloo 🧴
+
+> Sync your AI agent configurations and rules across platforms with ease
+
+**gloo** keeps your AI agent rules and MCP configurations in perfect sync across Claude Code, Cursor, Roo Code, and other AI development tools.
+
+## Quick Start
+
+```bash
+# Install globally
+npm install -g gloo
+
+# Or run directly
+npx gloo init
+```
+
+## Basic Usage
+
+### 1. Initialize Configuration
+
+```bash
+gloo init
+```
+
+This creates a `gloo.config.ts` file:
+
+```typescript
+import { Config } from 'gloo/types';
+
+export default {
+  rules: [
+    {
+      file: 'my-coding-rules.md',
+      to: './',
+      targets: ['claude', 'cursor']
+    }
+  ]
+} satisfies Config;
+```
+
+### 2. Sync Your Rules
+
+```bash
+gloo sync
+```
+
+This automatically creates:
+- `CLAUDE.md` (for Claude Code)
+- `.cursor/rules/my-coding-rules.md` (for Cursor)
+
+### 3. Add MCP Configurations
+
+```typescript
+export default {
+  rules: [
+    // ... your rules
+  ],
+  mcps: [
+    {
+      name: 'postgres',
+      config: {
+        command: 'npx',
+        args: ['pg-mcp-server'],
+        env: { DATABASE_URL: 'postgresql://localhost/mydb' }
+      },
+      targets: ['claude', 'cursor']
+    }
+  ]
+} satisfies Config;
+```
+
+## Configuration
+
+### Supported Agents
+
+- **Claude Code**: `.mcp.json`
+- **Cursor**: `~/.cursor/mcp.json`
+- **Roo Code/Cline**: `.roo/mcp.json`
+
+### Example Configuration
+
+```typescript
+import { Config } from 'gloo/types';
+
+export default {
+  configDir: '.gloo',
+  rules: [
+    {
+      file: 'coding-standards.md',
+      to: './',
+      targets: ['claude', 'cursor', 'roocode']
+    }
+  ],
+  mcps: [
+    {
+      name: 'database',
+      config: {
+        command: 'npx',
+        args: ['db-mcp-server']
+      },
+      targets: ['claude']
+    }
+  ],
+  mergeMcps: true
+} satisfies Config;
+```
+
+## Commands
+
+```bash
+gloo init          # Initialize configuration
+gloo sync          # Sync rules and MCPs
+gloo validate      # Validate configuration
+gloo clean         # Remove generated files
+gloo reset --force # Complete reset
+gloo backup list   # List backups
+```
+
+## Features
+
+- 🔄 **Multi-platform sync** - Works with all major AI coding assistants
+- 📦 **MCP support** - Model Context Protocol configuration management
+- 🎯 **Selective targeting** - Choose which agents get which rules
+- 🔙 **Backup system** - Automatic backups before changes
+- 🧹 **Clean management** - Easy cleanup and reset options
+- ⚡ **Fast** - Built with Bun for maximum performance
+
+## Installation
+
+```bash
+# NPM
+npm install -g gloo
+
+# Bun
+bun install -g gloo
+
+# Direct execution
+npx gloo init
+bunx gloo sync
+```
+
+## License
+
+MIT