Skip to main content

​
Prerequisites

Before installing Claude Code Copilot, ensure you have the following:

GitHub Copilot subscription

Active Copilot subscription (Individual, Business, or Enterprise)

Node.js 18+

Runtime environment for the proxy server

Claude Code CLI

Anthropic’s official CLI tool

Docker (optional)

For running the proxy as a persistent container
No Anthropic API key needed — This proxy uses your existing GitHub Copilot subscription to access Claude models.

​
System requirements

  • Operating system: macOS, Linux, or Windows (with WSL recommended)
  • Memory: Minimum 512MB RAM for the proxy server
  • Network: Internet connection for GitHub authentication and Copilot API access
  • Port availability: Port 18080 (default) must be available

​
Installation steps

1

Install Node.js

Download and install Node.js 18 or later from nodejs.orgVerify the installation:
node --version
# Should output v18.0.0 or higher
2

Install Claude Code CLI

Install Anthropic’s official Claude Code command-line tool globally:
npm install -g @anthropic-ai/claude-code
Verify the installation:
claude --version
3

Clone the repository

Clone the Claude Code Copilot repository to your local machine:
git clone https://github.com/samarth777/claude-code-copilot.git
cd claude-code-copilot
4

Authenticate with GitHub

Run the authentication script to connect your GitHub Copilot account:
node scripts/auth.mjs
This will open a browser window for GitHub OAuth authentication. See the Authentication guide for detailed instructions.
5

Start the proxy server

Use the convenient launch script to start everything:
./scripts/launch.sh
Or manually start the proxy and Claude Code:
docker compose up -d
ANTHROPIC_BASE_URL=http://localhost:18080 ANTHROPIC_API_KEY=copilot-proxy claude

​
Verification

Once installation is complete, verify that everything is working:
  1. Check proxy server status: 
    curl http://localhost:18080/health
  2. Launch Claude Code: 
    ANTHROPIC_BASE_URL=http://localhost:18080 ANTHROPIC_API_KEY=copilot-proxy claude
  3. Select a model: Inside Claude Code, type /model to see available Claude models
If you see the model selection menu, your installation is successful!

​
Environment variables

You can customize the proxy behavior with these environment variables:
VariableDefaultDescription
COPILOT_PROXY_PORT18080Port for the local proxy server
COPILOT_AUTH_FILE~/.claude-copilot-auth.jsonPath to saved OAuth token
BRAVE_API_KEY(none)Brave Search API key for enhanced web search
WEB_SEARCH_MAX_RESULTS5Maximum search results per query
Set environment variables before starting the proxy to customize its behavior.

​
NPM scripts

The project includes convenient npm scripts for common tasks:
package.json
{
  "scripts": {
    "auth": "node scripts/auth.mjs",
    "proxy": "node scripts/proxy.mjs",
    "start": "bash scripts/launch.sh"
  }
}
Run them with: 
npm run auth    # Authenticate with GitHub
npm run proxy   # Start proxy server
npm start       # Launch proxy + Claude Code

​
Next steps

Authentication

Learn about the GitHub OAuth flow and credential storage

Docker setup

Run the proxy as a persistent Docker container