@musashishao/agent-kit 1.2.2

package/README.md

@@ -0,0 +1,317 @@
+# Agent Kit
+
+> 🚀 The Ultimate AI Agent System for Modern Development
+> 
+> **16 Agents** • **42 Skills** • **13 Workflows** • **Multi-Platform Support**
+
+[![npm version](https://badge.fury.io/js/@musashishao%2Fagent-kit.svg)](https://www.npmjs.com/package/@musashishao/agent-kit)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+## ⚡ Quick Install
+
+```bash
+npx @musashishao/agent-kit init
+```
+
+Or install globally:
+
+```bash
+npm install -g @musashishao/agent-kit
+agent-kit init
+```
+
+This installs the `.agent` folder containing all templates into your project.
+
+## 📦 What's Included
+
+| Component | Count | Description |
+|-----------|-------|-------------|
+| **Agents** | 16 | Specialist AI personas (frontend, backend, security, etc.) |
+| **Skills** | 42 | Domain-specific knowledge modules |
+| **Workflows** | 13 | Slash command procedures |
+| **Templates** | 4 | Project templates (web, mobile, backend) |
+
+## 🔗 Multi-Platform Support
+
+Agent Kit works seamlessly with multiple AI coding assistants:
+
+| Platform | Status | Config File |
+|----------|--------|-------------|
+| **Codex CLI** | ✅ Full Support | `AGENTS.md` |
+| **Gemini CLI** | ✅ Full Support | `GEMINI.md` |
+| **Cursor** | ✅ Compatible | `.cursor/rules` |
+| **Claude Code** | ✅ Compatible | `CLAUDE.md` |
+| **Aider** | ✅ Compatible | `AGENTS.md` |
+
+---
+
+## 🎯 Codex CLI Integration
+
+### Quick Setup
+
+```bash
+# Step 1: Install Agent Kit
+npx @musashishao/agent-kit init
+
+# Step 2: Generate AGENTS.md for your project
+npx @musashishao/agent-kit codex --template web
+
+# Step 3: Sync workflows as slash commands
+npx @musashishao/agent-kit setup-codex
+
+# Step 4: Verify installation
+npx @musashishao/agent-kit doctor
+```
+
+### Available Templates
+
+| Template | Command | Use Case |
+|----------|---------|----------|
+| **Web** | `codex --template web` | Next.js, React, Tailwind |
+| **Mobile** | `codex --template mobile` | React Native, Flutter |
+| **Backend** | `codex --template backend` | Node.js, Express, APIs |
+| **Default** | `codex` | Generic projects |
+
+### Using Workflows in Codex CLI
+
+After running `setup-codex`, use Agent Kit workflows as slash commands:
+
+```bash
+# Create new features
+/kit-create blog with authentication
+
+# Debug issues
+/kit-debug why login returns 401
+
+# Design premium UI
+/kit-ui-ux-pro-max dashboard with glassmorphism
+
+# Quality optimization
+/kit-quality create production-ready checkout
+```
+
+---
+
+## 🛠 CLI Commands
+
+| Command | Description |
+|---------|-------------|
+| `init` | Install `.agent` folder into your project |
+| `codex` | Generate AGENTS.md for Codex CLI |
+| `setup-codex` | Sync workflows with Codex CLI slash commands |
+| `mcp` | MCP server management |
+| `agents` | List all available agents |
+| `skills` | List all skills by category |
+| `workflows` | List all workflows |
+| `doctor` | Health check and diagnostics |
+| `update` | Update to the latest version |
+| `status` | Check installation status |
+
+### Options
+
+```bash
+# Codex template options
+agent-kit codex --template web      # Web application
+agent-kit codex --template mobile   # Mobile app
+agent-kit codex --template backend  # Backend API
+agent-kit codex --force             # Overwrite existing
+
+# Init options
+agent-kit init --force              # Overwrite existing .agent folder
+agent-kit init --path ./myapp       # Install in specific directory
+
+# Setup-codex options
+agent-kit setup-codex --prefix my-  # Custom prefix for slash commands
+```
+
+---
+
+## 🔌 MCP Integration
+
+Agent Kit includes built-in MCP (Model Context Protocol) servers to extend your AI assistant's capabilities.
+
+### Quick Setup
+
+```bash
+# Build MCP servers
+npx @musashishao/agent-kit mcp build
+
+# Configure for Claude Desktop
+npx @musashishao/agent-kit mcp setup --client claude
+
+# Restart Claude Desktop
+```
+
+### Built-in Servers
+
+| Server | Tools | Description |
+|--------|-------|-------------|
+| **agent-kit-core** | 7 | Project analysis, agents/skills listing |
+| **agent-kit-git** | 5 | Git operations (status, diff, log) |
+| **agent-kit-fs** | 5 | File system operations |
+
+### MCP Commands
+
+```bash
+# Server management
+mcp setup --client claude  # Configure for Claude/Cursor
+mcp build                  # Build all servers
+mcp list                   # List available servers
+mcp status                 # Check status
+
+# Templates
+mcp create my-api --type api      # Create API server
+mcp create my-db --type database  # Create DB server
+mcp templates                     # List templates
+
+# Registry
+mcp search github                 # Search npm registry
+mcp install @anthropic/mcp-server-github  # Install from npm
+mcp featured                      # Show featured servers
+```
+
+### Available Templates
+
+| Template | Description |
+|----------|-------------|
+| `api` | REST API integration |
+| `database` | SQLite/PostgreSQL connector |
+| `web-scraper` | Web page scraper |
+| `custom` | Minimal starter template |
+
+---
+
+## 📁 Project Structure
+
+```
+.agent/
+├── agents/          # 16 Specialist Agents
+├── skills/          # 42 Skills
+├── workflows/       # 13 Slash Commands
+├── rules/           # Platform-specific rules
+│   ├── CODEX.md    # Codex CLI rules
+│   └── GEMINI.md   # Gemini CLI rules
+├── templates/       # Project templates
+└── ARCHITECTURE.md  # Full documentation
+```
+
+---
+
+## 🎯 Usage
+
+### Using Agents
+
+Mention an agent by name to invoke specialized expertise:
+
+```
+Use the @security-auditor to review authentication
+Use the @frontend-specialist to analyze React components
+Use the @debugger to fix the login issue
+```
+
+### Using Skills
+
+Skills are loaded automatically based on task context. The AI reads skill descriptions and applies relevant knowledge.
+
+### Using Workflows
+
+Invoke workflows with slash commands:
+
+| Command | Description |
+|---------|-------------|
+| `/brainstorm` | Explore options before implementation |
+| `/create` | Create new features or apps |
+| `/debug` | Systematic debugging |
+| `/deploy` | Deploy application |
+| `/enhance` | Improve existing code |
+| `/orchestrate` | Multi-agent coordination |
+| `/plan` | Create task breakdown |
+| `/preview` | Preview changes locally |
+| `/quality` | **NEW** Optimize output quality |
+| `/status` | Check project status |
+| `/test` | Generate and run tests |
+| `/context` | Context optimization |
+| `/ui-ux-pro-max` | Design with 50 styles |
+
+Example:
+```
+/brainstorm authentication system
+/create landing page with hero section
+/debug why login fails
+/quality create production-ready API
+```
+
+---
+
+## 🌐 Platform Setup Guides
+
+### Gemini CLI
+
+```bash
+# Install Agent Kit
+npx @musashishao/agent-kit init
+
+# Configure Gemini settings
+echo '{ "contextFileName": ".agent/rules/GEMINI.md" }' > .gemini/settings.json
+```
+
+### Cursor IDE
+
+```bash
+# Install Agent Kit
+npx @musashishao/agent-kit init
+
+# Copy rules to Cursor
+mkdir -p .cursor/rules
+cp .agent/rules/GEMINI.md .cursor/rules/agent-kit.md
+```
+
+### Claude Code
+
+```bash
+# Install Agent Kit
+npx @musashishao/agent-kit init
+
+# Copy rules for Claude
+cp .agent/rules/GEMINI.md CLAUDE.md
+```
+
+---
+
+## 📊 Quality Validation
+
+Ensure your setup is optimal:
+
+```bash
+# Run health check
+npx @musashishao/agent-kit doctor
+
+# Run quality validator
+python3 .agent/skills/context-engineering/scripts/quality_validator.py .
+```
+
+Expected output:
+```
+📊 Summary
+  Passed: 32/32 (100%)
+  ✓ Excellent! Agent Kit is fully configured for Codex CLI.
+```
+
+---
+
+## 📚 Documentation
+
+- **Website**: [agent-kit.musashi.works](https://agent-kit.musashi.works)
+- **AGENTS.md**: Project root
+- **ARCHITECTURE.md**: `.agent/ARCHITECTURE.md`
+- **Platform Guides**: `/docs/platforms/`
+
+---
+
+## 🤝 Contributing
+
+We welcome contributions! Please see `.agent/ARCHITECTURE.md` for guidelines.
+
+## License
+
+MIT © Musa (musashishao)