xc-copilot-api 1.2.0 → 1.2.2

package/README.md

@@ -35,7 +35,7 @@ A reverse-engineered proxy for the GitHub Copilot API that exposes it as an Open
 ## Features
 
 - **OpenAI & Anthropic Compatibility**: Exposes GitHub Copilot as an OpenAI-compatible (`/v1/chat/completions`, `/v1/models`, `/v1/embeddings`) and Anthropic-compatible (`/v1/messages`) API.
-- **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`).
+- **Claude Code & Codex CLI Integration**: Configure [Claude Code](https://docs.anthropic.com/en/docs/claude-code/overview) or Codex CLI to use Copilot as backend with `config --claude` or `config --codex`.
 - **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.
 - **Manual Request Approval**: Manually approve or deny each API request for fine-grained control over usage (`--manual`).
@@ -188,10 +188,28 @@ Copilot API now uses a subcommand structure with these main commands:
 
 - `start`: Start the Copilot API 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.
+- `config`: Configure external AI tools (Claude Code, Codex CLI) to use Copilot API.
 - `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.
 
-A separate **[`xc-copilot-api-daemon`](docs/daemon.md)** CLI is available for managing the server as a background daemon (install, status, restart, stop, uninstall, logs) on macOS, Linux, and Windows.
+### Running as a Background Service
+
+Use [easy-service](https://github.com/billxc/easy-service) to run as a background service on macOS, Linux, and Windows:
+
+```bash
+# Install easy-service
+uv tool install git+https://github.com/billxc/easy-service.git
+
+# Install and start the service
+easy-service install copilot-api -- npx -y xc-copilot-api@latest start
+
+# Manage the service
+easy-service status copilot-api
+easy-service logs copilot-api -f
+easy-service restart copilot-api
+easy-service stop copilot-api
+easy-service uninstall copilot-api
+```
 
 ## Command Line Options
 
@@ -208,10 +226,16 @@ The following command line options are available for the `start` command:
 | --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 API config              | false      | -c    |
 | --show-token   | Show GitHub and Copilot tokens on fetch and refresh                           | false      | none  |
 | --proxy-env    | Initialize proxy from environment variables                                   | false      | none  |
 
+### Config Command Options
+
+| Option  | Description                                       | Default | Alias |
+| ------- | ------------------------------------------------- | ------- | ----- |
+| --claude | Configure Claude Code (`~/.claude/settings.json`) | false   | -c    |
+| --codex  | Configure Codex CLI (`~/.codex/config.toml`)      | false   | -x    |
+
 ### Auth Command Options
 
 | Option       | Description               | Default | Alias |
@@ -328,44 +352,29 @@ The dashboard provides a user-friendly interface to view your Copilot usage data
 
 ## 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
+This proxy can be used to power [Claude Code](https://docs.anthropic.com/en/claude-code).
 
-To get started, run the `start` command with the `--claude-code` flag:
+The quickest way to get started:
 
 ```sh
-npx xc-copilot-api@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.
+# Start the server
+npx xc-copilot-api@latest start
 
-Paste and run this command in a new terminal to launch Claude Code.
+# Configure Claude Code (writes to ~/.claude/settings.json)
+npx xc-copilot-api@latest config --claude
+```
 
-### Manual Configuration with `settings.json`
+This merges the required `ANTHROPIC_BASE_URL` and `ANTHROPIC_AUTH_TOKEN` into your existing settings without overwriting other configuration. A backup of your original config is saved as `settings.json.bak`.
 
-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.
+> **Note:** Copilot API natively understands Claude model names (e.g. `claude-sonnet-4.5`, `opus[1m]`), so you don't need to set `ANTHROPIC_MODEL` or other model environment variables — they just work.
 
-Here is an example `.claude/settings.json` file:
+If you prefer manual configuration, add the following to your `~/.claude/settings.json`:
 
 ```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"
-    ]
+    "ANTHROPIC_AUTH_TOKEN": "Powered by xc copilot"
   }
 }
 ```
@@ -374,6 +383,30 @@ You can find more options here: [Claude Code settings](https://docs.anthropic.co
 
 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)
 
+## Using with Codex CLI
+
+```sh
+# Start the server
+npx xc-copilot-api@latest start
+
+# Configure Codex CLI (writes to ~/.codex/config.toml)
+npx xc-copilot-api@latest config --codex
+```
+
+A backup of your original config is saved as `config.toml.bak`.
+
+If you prefer manual configuration, add the following to your `~/.codex/config.toml`:
+
+```toml
+model = "gpt-5.4"
+model_provider = "copilot-api"
+
+[model_providers.copilot-api]
+name = "copilot-api"
+base_url = "http://localhost:4141/v1"
+wire_api = "responses"
+```
+
 ## Running from Source
 
 The project can be run from source in several ways:

package/dist/main.js

@@ -1,9 +1,9 @@
 #!/usr/bin/env node
 import { defineCommand, runMain } from "citty";
+import consola from "consola";
+import fs, { copyFile, mkdir, readFile, writeFile } from "node:fs/promises";
 import os, { homedir } from "node:os";
 import path, { join } from "node:path";
-import consola from "consola";
-import fs, { mkdir, readFile, writeFile } from "node:fs/promises";
 import { randomUUID } from "node:crypto";
 import { serve } from "srvx";
 import { getProxyForUrl } from "proxy-from-env";
@@ -17,7 +17,7 @@ import "hono/logger";
 
 //#region package.json
 var name = "xc-copilot-api";
-var version = "1.2.0";
+var version = "1.2.2";
 var description = "Turn GitHub Copilot into OpenAI/Anthropic API compatible server. Usable with Claude Code and Codex";
 var keywords = [
 	"proxy",
@@ -32,10 +32,7 @@ var repository = {
 };
 var author = "Xiaochen <wxc9312@gmail.com>";
 var type = "module";
-var bin = {
-	"xc-copilot-api": "./dist/main.js",
-	"xc-copilot-api-daemon": "./dist/daemon-main.js"
-};
+var bin = { "xc-copilot-api": "./dist/main.js" };
 var files = ["dist"];
 var scripts = {
 	"build": "tsdown",
@@ -465,7 +462,14 @@ const checkUsage = defineCommand({
 
 //#endregion
 //#region src/config.ts
-async function configureClaude() {
+async function backupFile(filePath) {
+	try {
+		const backupPath = `${filePath}.bak`;
+		await copyFile(filePath, backupPath);
+		consola.info(`Backup saved: ${backupPath}`);
+	} catch {}
+}
+async function configureClaude(port) {
 	const configDir = join(homedir(), ".claude");
 	const configPath = join(configDir, "settings.json");
 	await mkdir(configDir, { recursive: true });
@@ -484,11 +488,12 @@ async function configureClaude() {
 		...existing,
 		env: {
 			...existingEnv,
-			ANTHROPIC_BASE_URL: "http://localhost:4141",
+			ANTHROPIC_BASE_URL: `http://localhost:${port}`,
 			ANTHROPIC_AUTH_TOKEN: "Powered by xc copilot"
 		},
 		model: "opus[1m]"
 	};
+	await backupFile(configPath);
 	await writeFile(configPath, JSON.stringify(merged, null, 2) + "\n", "utf-8");
 	consola.success(`Claude Code configured: ${configPath}`);
 }
@@ -516,7 +521,7 @@ function setTomlSection(content, header, body) {
 	if (pattern.test(content)) return content.replace(pattern, block);
 	return content.trimEnd() + "\n\n" + block;
 }
-async function configureCodex() {
+async function configureCodex(port) {
 	const configDir = join(homedir(), ".codex");
 	const configPath = join(configDir, "config.toml");
 	await mkdir(configDir, { recursive: true });
@@ -531,7 +536,8 @@ async function configureCodex() {
 	}
 	content = setTomlTopLevelKey(content, "model", "gpt-5.4");
 	content = setTomlTopLevelKey(content, "model_provider", "copilot-api");
-	content = setTomlSection(content, "model_providers.copilot-api", "name = \"copilot-api\"\nbase_url = \"http://localhost:4141/v1\"\nwire_api = \"responses\"");
+	content = setTomlSection(content, "model_providers.copilot-api", `name = "copilot-api"\nbase_url = "http://localhost:${port}/v1"\nwire_api = "responses"`);
+	await backupFile(configPath);
 	await writeFile(configPath, content, "utf-8");
 	consola.success(`Codex CLI configured: ${configPath}`);
 }
@@ -552,6 +558,12 @@ const config = defineCommand({
 			type: "boolean",
 			default: false,
 			description: "Configure Codex CLI (~/.codex/config.toml)"
+		},
+		port: {
+			alias: "p",
+			type: "string",
+			default: "4141",
+			description: "Port the Copilot API server listens on"
 		}
 	},
 	async run({ args }) {
@@ -559,8 +571,9 @@ const config = defineCommand({
 			consola.error("Specify at least one: --claude or --codex");
 			process.exit(1);
 		}
-		if (args.claude) await configureClaude();
-		if (args.codex) await configureCodex();
+		const port = Number.parseInt(args.port, 10);
+		if (args.claude) await configureClaude(port);
+		if (args.codex) await configureCodex(port);
 	}
 });
 
@@ -1882,15 +1895,25 @@ function tryParsePayload(bodyText) {
 	}
 }
 const createResponses = async (bodyText, requestHeaders) => {
+	const filtered = filterUnsupportedTools(bodyText);
 	return postCopilotPassthrough({
 		path: "/responses",
-		body: bodyText,
+		body: filtered,
 		requestHeaders,
 		initiator: "user",
 		errorMessage: "Failed to create responses",
 		throwOnError: true
 	});
 };
+function filterUnsupportedTools(bodyText) {
+	const payload = tryParsePayload(bodyText);
+	if (!payload?.tools || !Array.isArray(payload.tools)) return bodyText;
+	const UNSUPPORTED_TOOL_TYPES = new Set(["image_generation"]);
+	const filtered = payload.tools.filter((tool) => !UNSUPPORTED_TOOL_TYPES.has(tool.type ?? ""));
+	if (filtered.length === payload.tools.length) return bodyText;
+	payload.tools = filtered;
+	return JSON.stringify(payload);
+}
 function getForwardHeaders(headers) {
 	return filterResponseHeaders(headers, RESPONSE_HEADERS_TO_FORWARD);
 }
@@ -1996,7 +2019,8 @@ async function runServer(options) {
 	consola.box(`🌐 Usage Viewer: https://billxc.github.io/copilot-api?endpoint=${serverUrl}/usage`);
 	serve({
 		fetch: server.fetch,
-		port: options.port
+		port: options.port,
+		idleTimeout: 255
 	});
 }
 const start = defineCommand({