@hsupu/copilot-api 0.7.17 → 0.7.18-beta

package/README.md

@@ -6,14 +6,13 @@
 > [!WARNING]
 > This is a reverse proxy for the GitHub Copilot API. It is not officially supported by GitHub and may break at any time. Use at your own risk.
 
-A reverse proxy that exposes GitHub Copilot API as OpenAI and Anthropic compatible API endpoints. Works with Claude Code and other tools that speak OpenAI or Anthropic protocols.
+A reverse proxy that exposes GitHub Copilot's API as standard OpenAI and Anthropic compatible endpoints. Works with Claude Code, Cursor, and other tools that speak these protocols.
 
 ## Quick Start
 
 ### Install from npm (Recommended)
 
 ```sh
-# Run directly
 npx -y @hsupu/copilot-api start
 ```
 
@@ -26,6 +25,12 @@ bun install
 bun run dev      # Development mode with hot reload
 bun run start    # Production mode
 bun run build    # Build for distribution
+
+# Testing
+bun test                   # Backend unit tests
+bun run test:all           # All backend tests
+bun run test:ui            # Frontend (History UI) tests
+bun run typecheck          # TypeScript type checking
 ```
 
 ## Using with Claude Code
@@ -57,18 +62,8 @@ Or manually create `~/.claude/settings.json`:
 
 Exposes both OpenAI and Anthropic compatible endpoints through a single proxy:
 
-- **Direct Anthropic path** — Uses Copilot API's anthropic endpoint
-- **Translated path** — Translates to OpenAI format and uses Copilot's OpenAI-compatible endpoint
-
-### Adaptive Rate Limiting
-
-Intelligent rate limiting with exponential backoff, replacing the upstream queue-based approach. Operates in three modes:
-
-- **Normal** — Requests pass through freely
-- **Rate-limited** — Queues requests with configurable intervals after hitting limits
-- **Recovering** — Gradually resumes normal operation after consecutive successes
-
-Learns from Copilot API's `Retry-After` headers for optimal retry timing.
+- **Direct Anthropic path** — Uses Copilot API's native Anthropic endpoint for Claude models
+- **Translated path** — Translates between OpenAI and Anthropic formats for other models
 
 ### Auto-Truncate
 
@@ -77,20 +72,18 @@ Automatically handles context length limits (enabled by default):
 - **Reactive** — Retries failed requests with a truncated payload when hitting token or byte limits
 - **Proactive** — Pre-checks requests against known model limits before sending
 - **Dynamic limit learning** — Adjusts limits based on actual API error responses
-- **Tool result compression** — Compresses old `tool_result` content before truncating messages, preserving more conversation context
-- Up to 5 retry attempts per request with 2% safety margin
+- **Tool result compression** — Compresses old `tool_result` content before truncating messages
 
 ### Message Sanitization
 
 Cleans up messages before forwarding to the API:
 
 - Filters orphaned `tool_use` / `tool_result` blocks (unpaired due to interrupted tool calls or truncation)
-- Handles server-side tools (`server_tool_use` / `*_tool_result`) that appear inline in assistant messages
-- Fixes double-serialized tool inputs from stream accumulation
-- Removes corrupted blocks from older history data
 - Fixes tool name casing mismatches
 - Removes empty text content blocks
 - Strips `<system-reminder>` tags from message content
+- **[Optional]** Deduplicates repeated tool calls (`config.yaml: anthropic.dedup_tool_calls`)
+- **[Optional]** Strips system-reminder tags from Read tool results (`config.yaml: anthropic.truncate_read_tool_result`)
 
 ### Model Name Translation
 
@@ -103,28 +96,26 @@ Translates client-sent model names to matching Copilot models:
 | `claude-sonnet-4-5-20250514` | `claude-sonnet-4.5` |
 | `claude-sonnet-4`, `gpt-4` | Passed through directly |
 
-Each model family has a priority list. Short aliases resolve to the first available model.
+User-configured `model_overrides` (via config.yaml) can redirect any model name to another, with chained resolution and family-level overrides.
 
 ### Server-Side Tools
 
-Supports Anthropic server-side tools (e.g., `web_search`, `tool_search`). These tools are executed by the API backend, with both `server_tool_use` and result blocks appearing inline in assistant messages. Tool definitions can optionally be rewritten to a custom format (configurable via `--no-rewrite-anthropic-tools`).
+Supports Anthropic server-side tools (`web_search`, `tool_search`). These tools are executed by the API backend, with both `server_tool_use` and result blocks appearing inline in assistant messages. Tool definitions can optionally be rewritten to a custom format (`--no-rewrite-anthropic-tools`).
 
 ### Request History UI
 
-Built-in web interface for inspecting API requests and responses. Access at `http://localhost:4141/history`.
+Built-in web interface for inspecting API requests and responses. Access at `http://localhost:4141/history/v3/`.
 
 - Real-time updates via WebSocket
 - Filter by model, endpoint, status, and time range
-- Full-text search across request/response content
-- Export as JSON or CSV
 - Session tracking and statistics
 
 ### Additional Features
 
-- **Sonnet → Opus redirection** — Optionally redirect sonnet model requests to the best available opus model
-- **Security research mode** — Passphrase-protected mode for authorized penetration testing, CTF competitions, and security education
-- **Tool name truncation** — Automatically truncates tool names exceeding 64 characters (OpenAI limit) with hash suffixes, restoring original names in responses
-- **Health checks** — Container-ready health endpoint at `/health`
+- **Model overrides** — Configure arbitrary model name redirections via config.yaml
+- **Adaptive rate limiting** — Intelligent rate limiting with exponential backoff (3 modes: Normal, Rate-limited, Recovering)
+- **Tool name truncation** — Truncates tool names exceeding 64 characters (OpenAI limit) with hash suffixes
+- **Health checks** — Container-ready endpoint at `/health`
 - **Graceful shutdown** — Connection draining on shutdown signals
 - **Proxy support** — HTTP/HTTPS proxy via environment variables
 
@@ -143,43 +134,49 @@ Built-in web interface for inspecting API requests and responses. Access at `htt
 
 ### `start` Options
 
+**General:**
+
 | Option | Default | Description |
 |--------|---------|-------------|
 | `--port`, `-p` | 4141 | Port to listen on |
 | `--host`, `-H` | (all interfaces) | Host/interface to bind to |
 | `--verbose`, `-v` | false | Enable verbose logging |
 | `--account-type`, `-a` | individual | Account type: `individual`, `business`, or `enterprise` |
-| `--manual` | false | Manual request approval mode |
 | `--github-token`, `-g` | | Provide GitHub token directly |
-| `--proxy-env` | false | Use proxy from environment variables |
-| `--history-limit` | 200 | Max history entries in memory (0 = unlimited) |
+| `--no-http-proxy-from-env` | enabled | Disable HTTP proxy from environment variables |
 
-**Rate Limiting:**
+**Auto-Truncate:**
 
 | Option | Default | Description |
 |--------|---------|-------------|
-| `--no-rate-limit` | false | Disable adaptive rate limiting |
-| `--retry-interval` | 10 | Seconds to wait before retrying after rate limit |
-| `--request-interval` | 10 | Seconds between requests in rate-limited mode |
-| `--recovery-timeout` | 10 | Minutes before attempting recovery |
-| `--consecutive-successes` | 5 | Consecutive successes needed to exit rate-limited mode |
+| `--no-auto-truncate` | enabled | Disable auto-truncation on context limit errors |
 
-**Auto-Truncate:**
+**Anthropic-Specific (via config.yaml):**
+
+These options are configured in `config.yaml` under the `anthropic:` section. See [`config.example.yaml`](config.example.yaml).
+
+| Config Key | Default | Description |
+|------------|---------|-------------|
+| `anthropic.rewrite_tools` | true | Rewrite server-side tools to custom format |
+| `stream_idle_timeout` | 300 | Max seconds between SSE events (0 = no timeout) |
+
+**Sanitization:**
 
 | Option | Default | Description |
 |--------|---------|-------------|
-| `--no-auto-truncate` | false | Disable auto-truncation on context limit errors |
-| `--no-compress-tool-results` | false | Disable tool result compression during truncation |
+| `--collect-system-prompts` | false | Collect system prompts to file |
 
-**Anthropic-Specific:**
+**Rate Limiting:**
 
 | Option | Default | Description |
 |--------|---------|-------------|
-| `--redirect-anthropic` | false | Force Anthropic requests through OpenAI translation |
-| `--no-rewrite-anthropic-tools` | false | Don't rewrite server-side tools to custom format |
-| `--redirect-count-tokens` | false | Route count_tokens through OpenAI translation |
-| `--redirect-sonnet-to-opus` | false | Redirect sonnet requests to best available opus |
-| `--security-research-mode` | | Enable security research mode with passphrase |
+| `--no-rate-limit` | enabled | Disable adaptive rate limiting |
+
+Rate limiter sub-parameters are configured in `config.yaml` under `rate_limiter:`. See [`config.example.yaml`](config.example.yaml).
+
+## Configuration
+
+Create a `config.yaml` in the working directory. See [`config.example.yaml`](config.example.yaml) for all available options.
 
 ## API Endpoints
 
@@ -188,6 +185,7 @@ Built-in web interface for inspecting API requests and responses. Access at `htt
 | Endpoint | Method | Description |
 |----------|--------|-------------|
 | `/v1/chat/completions` | POST | Chat completions |
+| `/v1/responses` | POST | Responses API |
 | `/v1/models` | GET | List available models |
 | `/v1/models/:model` | GET | Get specific model details |
 | `/v1/embeddings` | POST | Text embeddings |
@@ -200,7 +198,6 @@ All endpoints also work without the `/v1` prefix.
 |----------|--------|-------------|
 | `/v1/messages` | POST | Messages API |
 | `/v1/messages/count_tokens` | POST | Token counting |
-| `/api/event_logging/batch` | POST | Event logging (no-op, returns OK) |
 
 ### Utility
 
@@ -209,11 +206,12 @@ All endpoints also work without the `/v1` prefix.
 | `/health` | GET | Health check (200 healthy, 503 unhealthy) |
 | `/usage` | GET | Copilot usage and quota statistics |
 | `/token` | GET | Current Copilot token information |
-| `/history` | GET | Request history web UI |
+| `/history/v3/` | GET | History web UI |
 | `/history/ws` | WebSocket | Real-time history updates |
 | `/history/api/entries` | GET | Query history entries |
+| `/history/api/entries/:id` | GET | Get single entry |
+| `/history/api/summaries` | GET | Entry summaries |
 | `/history/api/stats` | GET | Usage statistics |
-| `/history/api/export` | GET | Export history (JSON/CSV) |
 | `/history/api/sessions` | GET | List sessions |
 
 ## Account Types

package/README.zh.md

@@ -0,0 +1,39 @@
+
+## 项目概述
+
+GitHub Copilot API 的逆向代理，将其暴露为 OpenAI 和 Anthropic 兼容端点。使得 Claude Code 等工具可以使用 GitHub Copilot 作为后端。
+
+## 常用命令
+
+```sh
+bun install              # 安装依赖
+bun run dev              # 开发模式（热重载）
+bun run start            # 生产模式
+bun run build            # 构建发布版（tsdown）
+bun run typecheck        # 类型检查
+bun run lint             # Lint 暂存文件
+bun run lint:all         # Lint 所有文件
+bun run knip             # 查找未使用的导出/依赖
+bun test                 # 运行所有测试
+bun test tests/foo.test.ts  # 运行单个测试文件
+```
+
+## API 端点
+
+| 端点 | 用途 |
+|------|------|
+| `/v1/chat/completions` | OpenAI 兼容 chat |
+| `/v1/messages` | Anthropic 兼容 messages |
+| `/v1/messages/count_tokens` | Anthropic 兼容 token 计数 |
+| `/v1/models` | 列出可用模型 |
+| `/v1/embeddings` | 文本嵌入 |
+| `/api/event_logging/batch` | Event logging（空操作） |
+| `/usage` | Copilot 配额/用量统计 |
+| `/health` | 健康检查 |
+| `/token` | 当前 Copilot token 信息 |
+| `/history` | 请求历史 Web UI（v1 和 v2） |
+| `/history/ws` | WebSocket 实时历史更新 |
+| `/history/api/entries` | 历史查询 API |
+| `/history/api/sessions` | 会话列表 API |
+| `/history/api/stats` | 统计 API |
+| `/history/api/export` | 导出历史（JSON/CSV） |