https://github.com/ericc-ch/copilot-api
GitHub Copilot API wrapper to make it OpenAI compatible
https://github.com/ericc-ch/copilot-api
github-copilot openai-api openai-compatible-api reverse-engineering
Last synced: 6 months ago
JSON representation
GitHub Copilot API wrapper to make it OpenAI compatible
- Host: GitHub
- URL: https://github.com/ericc-ch/copilot-api
- Owner: ericc-ch
- License: agpl-3.0
- Created: 2025-01-11T01:54:45.000Z (9 months ago)
- Default Branch: master
- Last Pushed: 2025-03-30T16:43:48.000Z (6 months ago)
- Last Synced: 2025-03-30T21:14:38.622Z (6 months ago)
- Topics: github-copilot, openai-api, openai-compatible-api, reverse-engineering
- Language: TypeScript
- Homepage:
- Size: 416 KB
- Stars: 72
- Watchers: 4
- Forks: 22
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Roadmap: docs/roadmap.md
Awesome Lists containing this project
- awesome-ChatGPT-repositories - copilot-api - Turn GitHub Copilot into OpenAI/Anthropic API compatible server. Usable with Claude Code! (Openai)
- awesome-claude-code - **copilot-api**
README
# 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.
[](https://ko-fi.com/E1E519XS7W)
## Project Overview
A wrapper around GitHub Copilot API to make it OpenAI compatible, making it usable for other tools like AI assistants, local interfaces, and development utilities.
## Demo
https://github.com/user-attachments/assets/7654b383-669d-4eb9-b23c-06d7aefee8c5
## Prerequisites
- Bun (>= 1.2.x)
- GitHub account with Copilot subscription (Individual or Business)
## Installation
To install dependencies, run:
```sh
bun install
```
## Using with docker
Build image
```sh
docker build -t copilot-api .
```
Run the container
```sh
docker run -p 4141:4141 copilot-api
```
## Using with npx
You can run the project directly using npx:
```sh
npx copilot-api@latest
```
With options:
```sh
npx copilot-api --port 8080
```
## Command Line Options
The following command line options are available:
| Option | Description | Default | Alias |
| ------------ | -------------------------------------------- | ------- | ----- |
| --port | Port to listen on | 4141 | -p |
| --verbose | Enable verbose logging | false | -v |
| --business | Use a business plan GitHub account | false | none |
| --manual | Enable manual request approval | false | none |
| --rate-limit | Rate limit in seconds between requests | none | -r |
| --wait | Wait instead of error when rate limit is hit | false | -w |
Example usage:
```sh
# Run on custom port with verbose logging
npx copilot-api@latest --port 8080 --verbose
# Use with a Business GitHub account
npx copilot-api@latest --business
# Enable manual approval for each request
npx copilot-api@latest --manual
# Set rate limit to 30 seconds between requests
npx copilot-api@latest --rate-limit 30
# Wait instead of error when rate limit is hit
npx copilot-api@latest --rate-limit 30 --wait
```
## Running from Source
The project can be run from source in several ways:
### Development Mode
```sh
bun run dev
```
### Production Mode
```sh
bun run start
```
## Usage Tips
- Consider using free models (e.g., Gemini, Mistral, Openrouter) as the `weak-model`
- Use architect mode sparingly
- Disable `yes-always` in your aider configuration
- Be mindful that Claude 3.7 thinking mode consumes more tokens
- Enable the `--manual` flag to review and approve each request before processing
- If you have a GitHub Business account with Copilot, use the `--business` flag
### Manual Request Approval
When using the `--manual` flag, the server will prompt you to approve each incoming request:
```
? Accept incoming request? › (y/N)
```
This helps you control usage and monitor requests in real-time.
## Roadmap
- [ ] Manual authentication flow
- [x] Manual request approval system
- [x] Rate limiting implementation
- [x] Token counting
- [x] Enhanced error handling and recovery