Installation Guide

This guide walks through every supported installation path for CodeJackRabbit step by step: CLI, MCP server, VS Code extension, SCM webhooks (GitHub, GitLab, Bitbucket, Azure DevOps), self-hosted server, and OmniWrap multi-language SDKs.

1. Prerequisites

• Node.js 20 or newer (node --version)
• Git 2.30 or newer (git --version)
• Optional for Boxed Coding Tasks: a local worktree-capable Git repository or a BoxFleet runtime token.

2. CLI Installation (cjr / codejackrabbit)

Option A: Signed Release Tarball (Global Install)

npm install -g https://cli.codejackrabbit.com/0.2.0/codejackrabbit-0.2.0.tgz
cjr --version
cjr doctor

Option B: Zero-Install Ephemeral Run (npx)

npx -y --package https://cli.codejackrabbit.com/0.2.0/codejackrabbit-0.2.0.tgz cjr review --local

Option C: Local Repository Checkout

npm ci
node apps/cli/cli.mjs doctor
npm link

Verify your setup:

cjr review --local

3. MCP Server Installation

The CodeJackRabbit MCP server (apps/mcp/server.mjs) speaks JSON-RPC 2.0 over stdio and works with Claude Code, Cursor, Windsurf, Cline, and VS Code Copilot.

Add to your client's MCP configuration file:

{
  "mcpServers": {
    "codejackrabbit": {
      "command": "cjr",
      "args": ["mcp"]
    }
  }
}

See the CLI reference for per-client MCP configuration paths (cjr ai connect --agent all --mcp).

4. VS Code / Cursor / Windsurf Extension

1. Install or launch the CodeJackRabbit extension in VS Code, Cursor, or Windsurf.
2. In editor Settings (settings.json), configure: ```json { "codejackrabbit.cliPath": "cjr", "codejackrabbit.serverUrl": "https://api.codejackrabbit.com", "codejackrabbit.profile": "chill" } ```
3. Open the Command Palette (Ctrl+Shift+P / Cmd+Shift+P) and run CodeJackRabbit: Review Changes.

5. GitHub App & SCM Webhooks

GitHub App

1. Configure your GitHub App credentials (App ID, private key, and webhook secret) in your server configuration or account portal.
2. Point your GitHub App webhook URL to https://api.codejackrabbit.com/webhooks/github.
3. Subscribe to pull_request, issue_comment, pull_request_review_comment, and check_run events.

GitLab, Bitbucket, and Azure DevOps

• GitLab: Point Merge Request and Note webhooks to /webhooks/gitlab with your GitLab token and webhook secret.
• Bitbucket: Point Pull Request webhooks to /webhooks/bitbucket with your Bitbucket token and webhook secret.
• Azure DevOps: Point Service Hooks to /webhooks/azure with your Azure DevOps token and webhook secret.

6. Multi-Language SDK Installation

Install the official SDK for your runtime from the jackai-dev GitHub organization (jackai-dev/codejackrabbit-sdk):

• TypeScript: https://github.com/jackai-dev/codejackrabbit-sdk-typescript
• JavaScript: https://github.com/jackai-dev/codejackrabbit-sdk-javascript
• Python: https://github.com/jackai-dev/codejackrabbit-sdk-python
• Go: https://github.com/jackai-dev/codejackrabbit-sdk-go
• Rust: https://github.com/jackai-dev/codejackrabbit-sdk-rust
• Java: https://github.com/jackai-dev/codejackrabbit-sdk-java
• .NET (C#): https://github.com/jackai-dev/codejackrabbit-sdk-dotnet
• Kotlin: https://github.com/jackai-dev/codejackrabbit-sdk-kotlin