@nick3/copilot-api 1.5.6 → 1.6.0

package/README.md

@@ -1,9 +1,9 @@
 # Copilot API Proxy
 
-English | [中文](./README_CN.md)
+English | [简体中文](./README.zh-CN.md)
 
 > [!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. In the current version, if not using opencode OAuth, the device ID and machine ID will be sent to GitHub Copilot. It is not recommended to use a large number of accounts on a single device; if necessary, it is advised to run them in Docker containers.
+> 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. In the current version, if not using opencode OAuth, the device ID and machine ID will be sent to GitHub Copilot.
 
 > [!WARNING]
 > **GitHub Security Notice:**  
@@ -44,7 +44,7 @@ English | [中文](./README_CN.md)
 
 ## 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).
+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 / Responses API or the Anthropic Messages API, including to power [Claude Code](https://docs.anthropic.com/en/docs/claude-code/overview).
 
 Compared with routing everything through plain Chat Completions compatibility, this proxy can prefer Copilot's native Anthropic-style Messages API for Claude-family models, preserve more native thinking/tool semantics, reduce unnecessary Premium request consumption on warmup or resumed tool turns, and expose phase-aware `gpt-5.4` / `gpt-5.3-codex` responses that are easier for users to follow.
 
@@ -128,10 +128,6 @@ When an Anthropic API key is configured, the proxy forwards Claude model token c
 > [!NOTE]
 > Anthropic's `/v1/messages/count_tokens` endpoint is **free** (no per-token cost). It is rate-limited to 100 RPM at Tier 1. The $5 credit purchase is only needed to activate API access — the token counting calls themselves cost nothing.
 
-## Demo
-
-https://github.com/user-attachments/assets/7654b383-669d-4eb9-b23c-06d7aefee8c5
-
 ## Prerequisites
 
 - Bun (>= 1.2.x)
@@ -145,6 +141,32 @@ To install dependencies, run:
 bun install
 ```
 
+To start the server directly from source:
+
+```sh
+bun run start start
+```
+
+## Using with npx
+
+You can run the project directly using npx:
+
+```sh
+npx @nick3/copilot-api@latest start
+```
+
+With options:
+
+```sh
+npx @nick3/copilot-api@latest start --port 8080
+```
+
+For authentication only:
+
+```sh
+npx @nick3/copilot-api@latest auth
+```
+
 ## Using with Docker
 
 Build image
@@ -233,26 +255,6 @@ The Docker image includes:
 - 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 @nick3/copilot-api@latest start
-```
-
-With options:
-
-```sh
-npx @nick3/copilot-api@latest start --port 8080
-```
-
-For authentication only:
-
-```sh
-npx @nick3/copilot-api@latest auth
-```
-
 ## Command Structure
 
 Copilot API now uses a subcommand structure with these main commands:
@@ -357,11 +359,14 @@ The `<target>` can be either the account ID (GitHub username) or a 1-based index
     },
     "allowOriginalModelNamesForAliases": false,
     "useFunctionApplyPatch": true,
+    "forceAgent": false,
     "compactUseSmallModel": true,
     "messageStartInputTokensFallback": false,
     "modelRefreshIntervalHours": 24,
+    "sessionAffinityRetentionDays": 7,
     "useMessagesApi": true,
-    "useResponsesApiWebSearch": true
+    "useResponsesApiWebSearch": true,
+    "logLevel": "info"
   }
   ```
 - **auth.apiKeys:** API keys used for request authentication. Supports multiple keys for rotation. Requests can authenticate with either `x-api-key: <key>` or `Authorization: Bearer <key>`. If empty or omitted, authentication is disabled.
@@ -411,10 +416,14 @@ The `<target>` can be either the account ID (GitHub username) or a 1-based index
 - **compactUseSmallModel:** When `true`, detected "compact" requests (e.g., from Claude Code or opencode compact mode) will automatically use the configured `smallModel` to avoid consuming premium usage for short/background tasks. Defaults to `true`.
 - **messageStartInputTokensFallback:** When `true`, the Anthropic streaming translation layer estimates `message_start.input_tokens` when upstream stream events do not provide it. Defaults to `false`.
 - **modelRefreshIntervalHours:** Interval for refreshing account model lists in the background. Set to `0` to disable refresh. Defaults to `24`.
+- **sessionAffinityRetentionDays:** Number of days to retain session affinity bindings. Defaults to `7`.
 - **useMessagesApi:** When `true` (default), Claude-family models that support Copilot's native `/v1/messages` endpoint may use the Messages API path. Set to `false` to skip the Messages API candidate and fall back to `/responses` (if supported) or `/chat/completions`.
 - **useResponsesApiWebSearch:** When `true` (default), `/v1/responses` keeps tools with `type: "web_search"` and forwards them upstream. Set to `false` to strip them before the Copilot request is sent.
+- **logLevel:** Controls handler file-log verbosity under `logs/*.log`. Allowed values: `error`, `warn`, `info`, `debug`. Defaults to `info`. Set it to `debug` when you need payload- or stream-level diagnostics written into file logs.
 - **anthropicApiKey:** Optional Anthropic API key used for accurate Claude token counting (see [Accurate Claude Token Counting](#accurate-claude-token-counting) below). Can also be set via the `ANTHROPIC_API_KEY` environment variable. If not set, token counting falls back to GPT tokenizer estimation.
 
+`--verbose` no longer implicitly enables debug-level file logging. If you need detailed handler logs under `logs/*.log`, explicitly set `"logLevel": "debug"` in `config.json`.
+
 Edit this file to customize prompts or swap in your own fast model. If you edit it manually, restart the server (or call `GET /api/admin/config`) so the cached config is refreshed. Changes made through the Admin UI/API are validated, written to disk, and applied immediately; unknown keys are rejected.
 
 ## API Authentication
@@ -824,7 +833,8 @@ Here is an example `.claude/settings.json` file:
   },
   "permissions": {
     "deny": [
-      "WebSearch"
+      "WebSearch",
+      "mcp__ide__executeCode"
     ]
   }
 }
@@ -910,13 +920,13 @@ The project can be run from source in several ways:
 ### Development Mode
 
 ```sh
-bun run dev
+bun run dev start
 ```
 
 ### Production Mode
 
 ```sh
-bun run start
+bun run start start
 ```
 
 ## Usage Tips