copilot-gateway 0.10.0

package/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2025 Erick Christian Purwanto
+Copyright (c) 2026-Now Pengfei Ni
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,444 @@
+# Copilot Gateway
+
+> [!WARNING]
+> This is a reverse-engineered proxy of GitHub Copilot API. It is not supported by GitHub, and may break unexpectedly. Use at your own risk.
+
+> [!WARNING]
+> **GitHub Security Notice:**  
+> Excessive automated or scripted use of Copilot (including rapid or bulk requests, such as via automated tools) may trigger GitHub's abuse-detection systems.  
+> You may receive a warning from GitHub Security, and further anomalous activity could result in temporary suspension of your Copilot access.
+>
+> GitHub prohibits use of their servers for excessive automated bulk activity or any activity that places undue burden on their infrastructure.
+>
+> Please review:
+>
+> - [GitHub Acceptable Use Policies](https://docs.github.com/site-policy/acceptable-use-policies/github-acceptable-use-policies#4-spam-and-inauthentic-activity-on-github)
+> - [GitHub Copilot Terms](https://docs.github.com/site-policy/github-terms/github-terms-for-additional-products-and-features#github-copilot)
+>
+> Use this proxy responsibly to avoid account restrictions.
+
+---
+
+**Note:** If you are using [opencode](https://github.com/sst/opencode), you do not need this project. Opencode supports GitHub Copilot provider out of the box.
+
+---
+
+## Project Overview
+
+A reverse-engineered proxy for the GitHub Copilot API that exposes it as an OpenAI and Anthropic compatible service. This allows you to use GitHub Copilot with any tool that supports the OpenAI Chat Completions API or the Anthropic Messages API, including to power [Claude Code](https://docs.anthropic.com/en/docs/claude-code/overview).
+
+## Features
+
+- **OpenAI & Anthropic Compatibility**: Exposes GitHub Copilot as an OpenAI-compatible (`/v1/responses`, `/v1/chat/completions`, `/v1/models`, `/v1/embeddings`) and Anthropic-compatible (`/v1/messages`) API, with additional no-prefix aliases for OpenAI-style routes.
+- **Claude Code Integration**: Easily configure and launch [Claude Code](https://docs.anthropic.com/en/docs/claude-code/overview) to use Copilot as its backend with a simple command-line flag (`--claude-code`).
+- **Usage Dashboard**: A web-based dashboard to monitor your Copilot API usage, view quotas, and see detailed statistics.
+- **Rate Limit Control**: Manage API usage with rate-limiting options (`--rate-limit`) and a waiting mechanism (`--wait`) to prevent errors from rapid requests on generation endpoints.
+- **Manual Request Approval**: Manually approve or deny each generation request for fine-grained control over usage (`--manual`).
+- **Token Visibility**: Option to display GitHub and Copilot tokens during authentication and refresh for debugging (`--show-token`).
+- **Flexible Authentication**: Authenticate interactively or provide a GitHub token directly, suitable for CI/CD environments.
+- **Support for Different Account Types**: Works with individual, business, and enterprise GitHub Copilot plans.
+- **GitHub Enterprise Support**: Compatible with GitHub Enterprise Server and GitHub Enterprise Cloud installations.
+
+## Prerequisites
+
+- Bun (>= 1.2.x)
+- GitHub account with Copilot subscription (individual, business, or enterprise)
+
+## Installation
+
+To install dependencies, run:
+
+```sh
+bun install
+```
+
+## Using with Docker
+
+Build image
+
+```sh
+docker build -t copilot-gateway .
+```
+
+Run the container
+
+```sh
+# Create a directory on your host to persist the GitHub token and related data
+mkdir -p ./copilot-data
+
+# Run the container with a bind mount to persist the token
+# This ensures your authentication survives container restarts
+
+docker run -p 4141:4141 -v $(pwd)/copilot-data:/root/.local/share/copilot-gateway copilot-gateway
+```
+
+> **Note:**
+> The GitHub token and related data will be stored in `copilot-data` on your host. This is mapped to `/root/.local/share/copilot-gateway` inside the container, ensuring persistence across restarts.
+> If you don't provide `GH_TOKEN`, make sure the mapped directory already contains a valid token from a previous auth flow.
+
+### Docker with Environment Variables
+
+You can pass the GitHub token directly to the container using environment variables:
+
+```sh
+# Build image
+docker build -t copilot-gateway .
+
+# Run with GitHub token
+docker run -p 4141:4141 -e GH_TOKEN=your_github_token_here copilot-gateway
+
+# Run with additional options
+docker run -p 4141:4141 -e GH_TOKEN=your_token copilot-gateway start --verbose --port 4141
+```
+
+### Docker Compose Example
+
+```yaml
+version: "3.8"
+services:
+  copilot-gateway:
+    build: .
+    ports:
+      - "4141:4141"
+    environment:
+      - GH_TOKEN=your_github_token_here
+    restart: unless-stopped
+```
+
+The Docker image includes:
+
+- Multi-stage build for optimized image size
+- Health check for container monitoring
+- Pinned base image version for reproducible builds
+
+## Using with npx
+
+You can run the project directly using npx:
+
+```sh
+npx copilot-gateway@latest start
+```
+
+With options:
+
+```sh
+npx copilot-gateway@latest start --port 8080
+```
+
+For authentication only:
+
+```sh
+npx copilot-gateway@latest auth
+```
+
+## Command Structure
+
+Copilot Gateway uses a subcommand structure with these main commands:
+
+- `start`: Start the Copilot Gateway server. This command will also handle authentication if needed.
+- `auth`: Run GitHub authentication flow without starting the server. This is typically used if you need to generate a token for use with the `--github-token` option, especially in non-interactive environments.
+- `check-usage`: Show your current GitHub Copilot usage and quota information directly in the terminal (no server required).
+- `debug`: Display diagnostic information including version, runtime details, file paths, and authentication status. Useful for troubleshooting and support.
+
+## Command Line Options
+
+### Start Command Options
+
+The following command line options are available for the `start` command:
+
+| Option         | Description                                                                   | Default    | Alias |
+| -------------- | ----------------------------------------------------------------------------- | ---------- | ----- |
+| --port         | Port to listen on                                                             | 4141       | -p    |
+| --verbose      | Enable verbose logging                                                        | false      | -v    |
+| --account-type | Account type to use (individual, business, enterprise)                        | individual | -a    |
+| --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    |
+| --github-token | Provide GitHub token directly (must be generated using the `auth` subcommand) | none       | -g    |
+| --claude-code  | Generate a command to launch Claude Code with Copilot Gateway config          | false      | -c    |
+| --show-token   | Show GitHub and Copilot tokens on fetch and refresh                           | false      | none  |
+| --proxy-env    | Initialize proxy from environment variables (Node.js runtime only)            | false      | none  |
+| --enterprise-url | GitHub Enterprise host to use (eg. https://ghe.example.com)               | none       | none  |
+| --api-key      | API keys for authentication. Can be specified multiple times                  | none       | none  |
+
+### Auth Command Options
+
+| Option       | Description               | Default | Alias |
+| ------------ | ------------------------- | ------- | ----- |
+| --verbose    | Enable verbose logging    | false   | -v    |
+| --show-token | Show GitHub token on auth | false   | none  |
+| --enterprise-url | GitHub Enterprise host (eg. https://ghe.example.com) | none | none |
+
+### Debug Command Options
+
+| Option | Description               | Default | Alias |
+| ------ | ------------------------- | ------- | ----- |
+| --json | Output debug info as JSON | false   | none  |
+
+## Configuration (config.json)
+
+- **Location:** `~/.local/share/copilot-gateway/config.json` (Linux/macOS) or `%USERPROFILE%\.local\share\copilot-gateway\config.json` (Windows).
+- **Related files in the same directory:** `github_token`, `enterprise_url`, and `logs/`.
+- **Default shape:**
+  ```json
+  {
+    "extraPrompts": {
+      "gpt-5-mini": "<built-in exploration prompt>",
+      "gpt-5.1-codex-max": "<built-in exploration prompt>"
+    },
+    "smallModel": "gpt-5-mini",
+    "modelReasoningEfforts": {
+      "gpt-5-mini": "low"
+    }
+  }
+  ```
+- **extraPrompts:** Map of `model -> prompt` appended to the first system prompt when translating Anthropic-style requests to Copilot. Use this to inject guardrails or guidance per model. Missing default entries are auto-added without overwriting your custom prompts.
+- **smallModel:** Fallback model used for tool-less warmup messages (e.g., Claude Code probe requests) to avoid spending premium requests; defaults to `gpt-5-mini`.
+- **modelReasoningEfforts:** Per-model `reasoning.effort` sent to the Copilot Responses API. Allowed values are `none`, `minimal`, `low`, `medium`, `high`, and `xhigh`. If a model isn’t listed, `high` is used by default.
+
+Edit this file to customize prompts or swap in your own fast model. Restart the server (or rerun the command) after changes so the cached config is refreshed.
+
+## API Endpoints
+
+The server exposes several endpoints to interact with the Copilot API. It provides OpenAI-compatible endpoints and now also includes support for Anthropic-compatible endpoints, allowing for greater flexibility with different tools and services.
+
+### OpenAI Compatible Endpoints
+
+These endpoints mimic the OpenAI API structure.
+
+| Endpoint                    | Method | Description                                                      |
+| --------------------------- | ------ | ---------------------------------------------------------------- |
+| `POST /v1/responses`        | `POST` | Advanced OpenAI response interface for generating model responses. |
+| `POST /v1/chat/completions` | `POST` | Creates a model response for the given chat conversation.        |
+| `GET /v1/models`            | `GET`  | Lists the currently available models.                            |
+| `POST /v1/embeddings`       | `POST` | Creates an embedding vector representing the input text.         |
+
+OpenAI-style compatibility aliases are also available without the `/v1` prefix:
+
+- `POST /responses`
+- `POST /chat/completions`
+- `GET /models`
+- `POST /embeddings`
+
+### Anthropic Compatible Endpoints
+
+These endpoints are designed to be compatible with the Anthropic Messages API.
+
+| Endpoint                         | Method | Description                                                  |
+| -------------------------------- | ------ | ------------------------------------------------------------ |
+| `POST /v1/messages`              | `POST` | Creates a model response for a given conversation.           |
+| `POST /v1/messages/count_tokens` | `POST` | Calculates the number of tokens for a given set of messages. |
+| `POST /api/event_logging/batch`  | `POST` | Anthropic telemetry log (ignore, just return 200)          |
+
+### Usage Monitoring Endpoints
+
+New endpoints for monitoring your Copilot usage and quotas.
+
+| Endpoint     | Method | Description                                                  |
+| ------------ | ------ | ------------------------------------------------------------ |
+| `GET /usage` | `GET`  | Get detailed Copilot usage statistics and quota information. |
+| `GET /token` | `GET`  | Get the current Copilot token being used by the API.         |
+
+## API Key Authentication
+
+The proxy supports API key authentication to restrict access to the endpoints. When API keys are configured, all API endpoints require authentication.
+
+### Authentication Methods
+
+The proxy supports both OpenAI and Anthropic authentication formats:
+
+- **OpenAI format**: Include the API key in the `Authorization` header with `Bearer` prefix:
+  ```bash
+  curl -H "Authorization: Bearer your_api_key_here" http://localhost:4141/v1/models
+  ```
+
+- **Anthropic format**: Include the API key in the `x-api-key` header:
+  ```bash
+  curl -H "x-api-key: your_api_key_here" http://localhost:4141/v1/messages
+  ```
+
+### Configuration
+
+Use the `--api-key` flag to enable API key authentication. You can specify multiple keys for different clients:
+
+```bash
+# Single API key
+npx copilot-gateway@latest start --api-key your_secret_key
+
+# Multiple API keys  
+npx copilot-gateway@latest start --api-key key1 --api-key key2 --api-key key3
+```
+
+When API keys are configured:
+- All API endpoints (`/v1/responses`, `/v1/chat/completions`, `/v1/models`, `/v1/embeddings`, `/v1/messages`, `/usage`, `/token`, and their non-`/v1` OpenAI aliases) require authentication
+- Requests without valid API keys will receive a 401 Unauthorized response
+- The root endpoint `/` remains accessible without authentication
+
+## Example Usage
+
+Using with npx:
+
+```sh
+# Basic usage with start command
+npx copilot-gateway@latest start
+
+# Run on custom port with verbose logging
+npx copilot-gateway@latest start --port 8080 --verbose
+
+# Use with a business plan GitHub account
+npx copilot-gateway@latest start --account-type business
+
+# Use with an enterprise plan GitHub account
+npx copilot-gateway@latest start --account-type enterprise
+
+# Enable manual approval for each request
+npx copilot-gateway@latest start --manual
+
+# Set rate limit to 30 seconds between requests
+npx copilot-gateway@latest start --rate-limit 30
+
+# Wait instead of error when rate limit is hit
+npx copilot-gateway@latest start --rate-limit 30 --wait
+
+# Provide GitHub token directly
+npx copilot-gateway@latest start --github-token ghp_YOUR_TOKEN_HERE
+
+# Enable API key authentication with a single key
+npx copilot-gateway@latest start --api-key your_secret_key_here
+
+# Enable API key authentication with multiple keys
+npx copilot-gateway@latest start --api-key key1 --api-key key2 --api-key key3
+
+# Run only the auth flow
+npx copilot-gateway@latest auth
+
+# Run auth flow with verbose logging
+npx copilot-gateway@latest auth --verbose
+
+# Show your Copilot usage/quota in the terminal (no server needed)
+npx copilot-gateway@latest check-usage
+
+# Display debug information for troubleshooting
+npx copilot-gateway@latest debug
+
+# Display debug information in JSON format
+npx copilot-gateway@latest debug --json
+
+# Initialize proxy from environment variables (HTTP_PROXY, HTTPS_PROXY, etc.)
+# Note: this option is currently relevant for Node.js runtime paths; Bun generally uses its own proxy behavior.
+npx copilot-gateway@latest start --proxy-env
+
+# Use GitHub Enterprise / GitHub Enterprise Server
+npx copilot-gateway@latest start --account-type enterprise --enterprise-url https://ghe.example.com
+
+# Authenticate with GitHub Enterprise interactively (will prompt for enterprise host)
+npx copilot-gateway@latest auth
+
+# Authenticate with GitHub Enterprise using CLI flag (for scripting)
+npx copilot-gateway@latest auth --enterprise-url ghe.example.com
+```
+
+## Using the Usage Viewer
+
+After starting the server, a URL to the Copilot Usage Dashboard will be displayed in your console. This dashboard is a web interface for monitoring your API usage.
+
+1.  Start the server. For example, using npx:
+    ```sh
+    npx copilot-gateway@latest start
+    ```
+2.  The server will output a URL to the usage viewer. Copy and paste this URL into your browser. It will look something like this:
+    `https://feiskyer.github.io/copilot-gateway?endpoint=http://localhost:4141/usage`
+    - If you use the `start.bat` script on Windows, this page will open automatically.
+
+The dashboard provides a user-friendly interface to view your Copilot usage data:
+
+- **API Endpoint URL**: The dashboard is pre-configured to fetch data from your local server endpoint via the URL query parameter. You can change this URL to point to any other compatible API endpoint.
+- **Fetch Data**: Click the "Fetch" button to load or refresh the usage data. The dashboard will automatically fetch data on load.
+- **Usage Quotas**: View a summary of your usage quotas for different services like Chat and Completions, displayed with progress bars for a quick overview.
+- **Detailed Information**: See the full JSON response from the API for a detailed breakdown of all available usage statistics.
+- **URL-based Configuration**: You can also specify the API endpoint directly in the URL using a query parameter. This is useful for bookmarks or sharing links. For example:
+  `https://feiskyer.github.io/copilot-gateway?endpoint=http://your-api-server/usage`
+
+## Using with Claude Code
+
+This proxy can be used to power [Claude Code](https://docs.anthropic.com/en/claude-code), an experimental conversational AI assistant for developers from Anthropic.
+
+There are two ways to configure Claude Code to use this proxy:
+
+### Interactive Setup with `--claude-code` flag
+
+To get started, run the `start` command with the `--claude-code` flag:
+
+```sh
+npx copilot-gateway@latest start --claude-code
+```
+
+You will be prompted to select a primary model and a "small, fast" model for background tasks. After selecting the models, a command will be copied to your clipboard. This command sets the necessary environment variables for Claude Code to use the proxy.
+
+Paste and run this command in a new terminal to launch Claude Code.
+
+### Manual Configuration with `settings.json`
+
+Alternatively, you can configure Claude Code by creating a `.claude/settings.json` file in your project's root directory. This file should contain the environment variables needed by Claude Code. This way you don't need to run the interactive setup every time.
+
+Here is an example `.claude/settings.json` file:
+
+```json
+{
+  "env": {
+    "ANTHROPIC_BASE_URL": "http://localhost:4141",
+    "ANTHROPIC_AUTH_TOKEN": "dummy",
+    "ANTHROPIC_MODEL": "gpt-4.1",
+    "ANTHROPIC_DEFAULT_SONNET_MODEL": "gpt-4.1",
+    "ANTHROPIC_SMALL_FAST_MODEL": "gpt-4.1",
+    "ANTHROPIC_DEFAULT_HAIKU_MODEL": "gpt-4.1",
+    "DISABLE_NON_ESSENTIAL_MODEL_CALLS": "1",
+    "CLAUDE_CODE_DISABLE_NONESSENTIAL_TRAFFIC": "1"
+  },
+  "permissions": {
+    "deny": [
+      "WebSearch"
+    ]
+  }
+}
+```
+
+You can find more options here: [Claude Code settings](https://docs.anthropic.com/en/docs/claude-code/settings#environment-variables)
+
+You can also read more about IDE integration here: [Add Claude Code to your IDE](https://docs.anthropic.com/en/docs/claude-code/ide-integrations)
+
+## 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
+
+- To avoid hitting GitHub Copilot's rate limits, you can use the following flags:
+  - `--manual`: Enables manual approval for each request, giving you full control over when requests are sent.
+  - `--rate-limit <seconds>`: Enforces a minimum time interval between requests. For example, `copilot-gateway start --rate-limit 30` will ensure there's at least a 30-second gap between requests.
+  - `--wait`: Use this with `--rate-limit`. It makes the server wait for the cooldown period to end instead of rejecting the request with an error. This is useful for clients that don't automatically retry on rate limit errors.
+- If you have a GitHub business or enterprise plan account with Copilot, use the `--account-type` flag (e.g., `--account-type business`). See the [official documentation](https://docs.github.com/en/enterprise-cloud@latest/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/managing-github-copilot-access-to-your-organizations-network#configuring-copilot-subscription-based-network-routing-for-your-enterprise-or-organization) for more details.
+- For GitHub Enterprise Server/Cloud users: Use `--enterprise-url` to specify your enterprise host (e.g., `--enterprise-url https://ghe.example.com`). The interactive auth command (`copilot-gateway auth`) will prompt you for your enterprise host if you don't provide it via the CLI flag.
+
+
+
+
+## Credits
+
+<detail>
+This project is maintained as a fork/rebrand of the original
+[`ericc-ch/copilot-api`](https://github.com/ericc-ch/copilot-api).
+Huge thanks to [@ericc-ch](https://github.com/ericc-ch) and all contributors for the original implementation.
+</detail>