canoryiq-setup
v1.0.0
Published
Smart installer for CanoryIQ MCP server - automatically configures Claude Code
Downloads
7
Maintainers
Readme
CanoryIQ Setup
Smart installer for CanoryIQ MCP server - automatically configures Claude Code with AI governance.
🚀 One-Line Install
npx canoryiq-setupWhat 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
# Install and configure CanoryIQ
npx canoryiq-setup
# Restore previous configuration
npx canoryiq-setup --rollback
# Show help
npx canoryiq-setup --helpWhat You Need
- Node.js 14+ installed
- Claude Code installed
- CanoryIQ API key from canoryiq.ai/admin/mcp
How It Works
- Detects your OS and finds Claude Code config location
- Installs MCP server via NPM if not already installed
- Prompts for API key (get from canoryiq.ai)
- Creates backup of existing configuration
- Merges config with existing MCP servers (doesn't overwrite)
- 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
- Restart Claude Code completely (close and reopen)
- Look for "CanoryIQ" in your available tools
- Visit canoryiq.ai/dashboard to monitor activity
Troubleshooting
NPM Permission Issues:
# Use npx (recommended)
npx canoryiq-setup
# Or fix NPM permissions
npm config set prefix ~/.npm-global
export PATH=~/.npm-global/bin:$PATHConfig 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
--rollbackto restore previous configuration - Check the backup files in your Claude config directory
- Contact support at canoryiq.ai/contact
Manual Installation
If the auto-installer doesn't work, you can configure manually:
- Install the package:
npm install -g canoryiq-mcp-server - Add to your
claude_desktop_config.json:
{
"mcpServers": {
"canoryiq": {
"command": "canoryiq-mcp-server",
"args": ["--api-key", "YOUR_API_KEY", "--server-url", "https://canoryiq.ai"]
}
}
}Support
- Documentation: canoryiq.ai/documentation
- Support: canoryiq.ai/contact
- GitHub: github.com/canoryiq/mcp-server
Made with ❤️ by the CanoryIQ team
