canoryiq-setup/README.md

Smart installer for CanoryIQ MCP server - automatically configures Claude Code

# CanoryIQ Setup

**Smart installer for CanoryIQ MCP server** - automatically configures Claude Code with AI governance.

## 🚀 One-Line Install

```bash
npx canoryiq-setup
```

## What This Does

✅ **Installs** the `canoryiq-mcp-server` NPM package globally  
✅ **Auto-detects** your Claude Code configuration location  
✅ **Safely merges** with existing MCP server configurations  
✅ **Creates backups** of your existing config  
✅ **Validates** the installation  
✅ **Provides rollback** if something goes wrong  

## Usage

```bash
# Install and configure CanoryIQ
npx canoryiq-setup

# Restore previous configuration  
npx canoryiq-setup --rollback

# Show help
npx canoryiq-setup --help
```

## What You Need

1. **Node.js 14+** installed
2. **Claude Code** installed  
3. **CanoryIQ API key** from [canoryiq.ai/admin/mcp](https://canoryiq.ai/admin/mcp)

## How It Works

1. **Detects your OS** and finds Claude Code config location
2. **Installs MCP server** via NPM if not already installed  
3. **Prompts for API key** (get from canoryiq.ai)
4. **Creates backup** of existing configuration
5. **Merges config** with existing MCP servers (doesn't overwrite)
6. **Validates installation** and provides next steps

## Configuration Locations

- **Windows:** `%APPDATA%\Claude\claude_desktop_config.json`
- **macOS:** `~/Library/Application Support/Claude/claude_desktop_config.json`  
- **Linux:** `~/.config/claude/claude_desktop_config.json`

## After Installation

1. **Restart Claude Code** completely (close and reopen)
2. Look for **"CanoryIQ"** in your available tools
3. Visit **[canoryiq.ai/dashboard](https://canoryiq.ai/dashboard)** to monitor activity

## Troubleshooting

**NPM Permission Issues:**
```bash
# Use npx (recommended)
npx canoryiq-setup

# Or fix NPM permissions
npm config set prefix ~/.npm-global
export PATH=~/.npm-global/bin:$PATH
```

**Config File Not Found:**
- Make sure Claude Code is installed
- Check that you have write permissions to the config directory
- Try running as administrator/sudo if needed

**Installation Failed:**
- Use `--rollback` to restore previous configuration
- Check the backup files in your Claude config directory
- Contact support at [canoryiq.ai/contact](https://canoryiq.ai/contact)

## Manual Installation

If the auto-installer doesn't work, you can configure manually:

1. Install the package: `npm install -g canoryiq-mcp-server`
2. Add to your `claude_desktop_config.json`:

```json
{
  "mcpServers": {
    "canoryiq": {
      "command": "canoryiq-mcp-server",
      "args": ["--api-key", "YOUR_API_KEY", "--server-url", "https://canoryiq.ai"]
    }
  }
}
```

## Support

- **Documentation:** [canoryiq.ai/documentation](https://canoryiq.ai/documentation)
- **Support:** [canoryiq.ai/contact](https://canoryiq.ai/contact)
- **GitHub:** [github.com/canoryiq/mcp-server](https://github.com/canoryiq/mcp-server)

---

Made with ❤️ by the CanoryIQ team