Copilot API

⚠️ EDUCATIONAL PURPOSE ONLY ⚠️ This project is a reverse-engineered implementation of the GitHub Copilot API created for educational purposes only. It is not officially supported by GitHub and should not be used in production environments.

Project Overview

A wrapper around GitHub Copilot API to make it OpenAI compatible, making it usable for other tools.

Note: Image/vision capabilities are not supported as GitHub Copilot's API does not support image input.

Prerequisites

• Bun (version 1.0.0 or higher)
• GitHub account with Copilot Individual subscription

Installation

To install dependencies, run:

bun install

Running the Project

The project can be run in several ways:

Development Mode

bun run dev

Starts the server with hot reloading enabled, which automatically restarts the server when code changes are detected. This is ideal for development.

Production Mode

bun run start

Runs the server in production mode with optimizations enabled and hot reloading disabled. Use this for deployment or production environments.

Command Line Options

The server accepts several command line options:

Option	Description	Default
--help, -h	Show help message	false
--emulate-streaming	Enable streaming response emulation	false
--port, -p	Port to listen on	4141

Example with options:

bun run start --port 8080 --emulate-streaming

In all cases, the server will start and listen for API requests on the specified port.

Tested Tools Compatibility

The following AI tools have been tested with this API:

Cline

• Works with GPT-4o
• Not compatible with Claude 3.5 Sonnet (prompts too long)

Aider

• Fully compatible

bolt.diy

• Works with some caveats:
  • Sometimes models fail to load - you can set any random API key in the UI to refresh the models list
  • May encounter "The operation is insecure." issue #362

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

This project is licensed under the GNU General Public License v3.0.