Copilot API Server Proxy

0.7.0 · active · verified Tue Apr 21

copilot-api transforms GitHub Copilot into an API-compatible server that mimics OpenAI and Anthropic interfaces, making Copilot's capabilities accessible to applications designed for these popular LLM APIs. This allows tools like Claude Code to leverage GitHub Copilot directly. The package is currently at version 0.7.0 and receives frequent updates, often with minor feature additions and bug fixes, as seen in recent patch and minor releases. Its key differentiator is bridging GitHub Copilot's proprietary access with standard API formats, offering flexibility for developers who want to integrate Copilot into existing LLM toolchains without vendor lock-in to GitHub's specific integration methods. It runs as a standalone server, typically invoked via `npx`.

Common errors

```
ReferenceError: require is not defined in ES module scope
```
cause Attempting to import `copilot-api` using CommonJS `require()` syntax in an ESM project or a JavaScript file without `"type": "module"`.

fix Switch to ES module `import` syntax (e.g., `import { startServer } from 'copilot-api'`) and ensure your Node.js project or file is configured for ESM.
```
Proxy settings are not working/applied when running copilot-api.
```
cause Since v0.7.0, proxy environment variables (`HTTP_PROXY`, `HTTPS_PROXY`) are no longer automatically enabled.

fix Restart the `copilot-api` server with the `--proxy-env` flag (e.g., `npx copilot-api@latest start --proxy-env`) or ensure `useProxyEnv: true` is passed in programmatic configurations.
```
Error: Could not get Copilot token. Please make sure Copilot is running and logged in.
```
cause The `copilot-api` server failed to establish communication with or retrieve an authentication token from a valid GitHub Copilot instance.

fix Ensure that GitHub Copilot is actively running and authenticated on your system (e.g., via VS Code or GitHub CLI) before starting the `copilot-api` server.

Warnings

breaking Proxy environment variables (e.g., HTTP_PROXY, HTTPS_PROXY) are no longer automatically initialized or detected by the server by default.
Fix: To enable proxy support from environment variables, you must explicitly use the `--proxy-env` flag when starting the server via CLI (e.g., `npx copilot-api start --proxy-env`) or set `useProxyEnv: true` in programmatic configurations.
gotcha This package is an ECMAScript Module (ESM) and does not support direct `require()` calls from CommonJS environments.
Fix: Ensure your project is configured for ESM (e.g., by setting `"type": "module"` in `package.json` or using `.mjs` file extensions) and use `import` statements for programmatic access.
gotcha The `copilot-api` server relies on a locally authenticated GitHub Copilot session to function. It does not handle Copilot authentication itself.
Fix: Verify that GitHub Copilot is installed and logged in on the machine running the `copilot-api` server. This typically involves having VS Code with the Copilot extension or the GitHub CLI with Copilot features enabled and authenticated.

Install

npm install copilot-api npm
yarn add copilot-api yarn
pnpm add copilot-api pnpm

Imports

startServer
wrong:
```
const { startServer } = require('copilot-api')
```
correct:
```
import { startServer } from 'copilot-api'
```
This package is primarily a CLI tool. Programmatic usage via 'startServer' is for embedding the server within another application. It is an ESM-only package.
CopilotApiConfig
wrong:
```
import { CopilotApiConfig } from 'copilot-api'
```
correct:
```
import type { CopilotApiConfig } from 'copilot-api'
```
Type import for configuring the Copilot API server programmatically. While 'import { ... }' also works, 'import type' is preferred for clarity and bundle optimization.
default
wrong:
```
import CopilotApi from 'copilot-api'
```
correct:
```
(No default export)
```
The 'copilot-api' package does not provide a default export. Use named imports for specific programmatic components or rely on the 'npx copilot-api' CLI for standard operation.

Quickstart

Demonstrates how to programmatically start the Copilot API server within a Node.js application, allowing for custom configuration beyond CLI arguments and illustrating basic setup.

import { startServer } from 'copilot-api';
import { fileURLToPath } from 'url';
import path from 'path';

// ESM equivalent of __dirname
const __filename = fileURLToPath(import.meta.url);
const __dirname = path.dirname(__filename);

async function runCopilotApiServer() {
  const config = {
    port: 3000,
    host: '0.0.0.0',
    // Example: Pass a custom path to a session token file if needed
    // copilotTokenPath: path.join(__dirname, 'copilot_session.json'),
    // As of v0.7.0, proxy environment variables require explicit enabling:
    // useProxyEnv: true, // Corresponds to --proxy-env CLI flag
    // Enable Claude Code specific environment variables:
    // enableClaudeCode: true, // Corresponds to --claude-code CLI flag
  };

  console.log('Starting Copilot API server programmatically...');
  try {
    await startServer(config);
    console.log(`Copilot API server listening on http://${config.host}:${config.port}`);
    console.log('Use Ctrl+C to stop the server.');
  } catch (error) {
    console.error('Failed to start Copilot API server:', error);
    process.exit(1);
  }
}

runCopilotApiServer();

view raw JSON →