@dianshuv/copilot-api 0.10.1 → 0.11.0

package/README.md

@@ -57,7 +57,7 @@ make down
 | Option | Description | Default |
 |--------|-------------|---------|
 | `--port`, `-p` | Port to listen on | 4141 |
-| `--host`, `-H` | Host/interface to bind to | (all interfaces) |
+| `--host`, `-H` | Host/interface to bind to (`0.0.0.0` = all interfaces) | `127.0.0.1` |
 | `--verbose`, `-v` | Enable verbose logging | false |
 | `--account-type`, `-a` | Account type (individual, business, enterprise) | individual |
 | `--manual` | Manual request approval mode | false |
@@ -200,17 +200,23 @@ The startup banner prints whether auth is on/off and, when on, the source
 
 ### Network binding
 
-The proxy **binds all interfaces (`0.0.0.0`) by default**, so a key-less
-instance is reachable from anywhere on your network. For a local-only,
-unauthenticated instance, bind loopback explicitly:
+The proxy **binds loopback (`127.0.0.1`) by default**, so an unconfigured
+instance is reachable only from the local machine. To expose it on your network
+— behind auth, a tunnel, or inside a container — opt into an all-interfaces
+bind explicitly:
 
 ```sh
-copilot-api start --host 127.0.0.1
+copilot-api start --host 0.0.0.0
 ```
 
-The startup banner reports the **real** bind address (`0.0.0.0` for an
-all-interfaces bind, or the narrowed host you passed), so a wide-open bind is
-never hidden.
+The bind host resolves with **`--host` flag > `HOST` env > `127.0.0.1`**. Note
+that a `HOST` env var — inherited from your shell or a container — also widens
+the bind: `HOST=0.0.0.0` opens all interfaces just like the flag. A *blank*
+`HOST` (`HOST=`, or `HOST=$UNSET`) is ignored and falls back to the loopback
+default, so an accidentally-empty env var can't silently expose the proxy. The
+startup banner always reports the **real** bind address (`127.0.0.1` for the
+loopback default, `0.0.0.0` for an all-interfaces bind, or the narrowed host you
+passed), so a wide-open bind is never hidden.
 
 ### Choosing a key
 
@@ -277,8 +283,8 @@ a custom header, so when auth is on they stop working:
 
 Workarounds:
 
-- Run a **separate local, unauthenticated instance** (`--host 127.0.0.1` with no
-  `--api-key`) for the browser UI, or
+- Run a **separate local, unauthenticated instance** (no `--api-key`; the
+  default `127.0.0.1` bind keeps it local) for the browser UI, or
 - Hit the history JSON API directly with a key, e.g.
   `curl -H "Authorization: Bearer $COPILOT_API_KEY" http://127.0.0.1:4141/history/api/entries`.
 

package/dist/main.mjs

@@ -1348,7 +1348,7 @@ const patchClaude = defineCommand({
 
 //#endregion
 //#region package.json
-var version = "0.10.1";
+var version = "0.11.0";
 
 //#endregion
 //#region src/lib/adaptive-rate-limiter.ts
@@ -1762,6 +1762,44 @@ function resolveProxyApiKey(sources) {
 	};
 }
 /**
+* Resolve the hostname the server will *actually* bind to, decided at the CLI
+* edge with flag-over-env precedence and a **safe loopback default** — the same
+* flag-over-env shape this codebase already uses to reconcile a CLI flag with
+* its env twin (`--api-key`/`COPILOT_API_KEY`, `--github-token`/`GH_TOKEN`).
+*
+*  - `--host` flag wins when present; otherwise the `HOST` env; otherwise the
+*    default `127.0.0.1`.
+*  - The default is **loopback, not all-interfaces**: an unconfigured instance
+*    must not expose `/token` (which echoes the plaintext Copilot token) and the
+*    otherwise-unauthenticated API to the whole network. Binding every interface
+*    is now an explicit opt-in — pass `--host 0.0.0.0` (or `HOST=0.0.0.0`).
+*  - **flag vs env asymmetry on a blank value** (the security-critical part): an
+*    explicit `--host` flag is the operator's deliberate choice, so a blank flag
+*    (`--host ""` / whitespace) is taken as the wildcard-bind escape hatch and
+*    canonicalized to an explicit `0.0.0.0` (rather than left as `""` to lean on
+*    srvx's undocumented empty-string handling). But a *set-but-blank* `HOST` env
+*    (`HOST=`, or `HOST=$UNSET` in a shell / compose where the var is unset →
+*    empty — NOT a deliberate keystroke) is accidental plumbing, so it is treated
+*    as **not provided** and falls through to the loopback default. This mirrors
+*    `resolveProxyApiKey` trimming `""` to not-provided, so an empty `HOST` can't
+*    silently reopen the all-interfaces-unauthenticated exposure the loopback
+*    default exists to prevent.
+*  - **Both sources are trimmed**: a padded `--host " 10.0.0.5 "` or
+*    `HOST=" 10.0.0.5 "` would otherwise reach the socket bind verbatim and fail
+*    with `ENOTFOUND`. Trimming also decides blank-ness for the rules above.
+*
+* `env` is passed in (not read here) to keep the function pure and unit-testable.
+*/
+function resolveBindHost(flag, env) {
+	if (flag !== void 0) {
+		const trimmed = flag.trim();
+		return trimmed === "" ? "0.0.0.0" : trimmed;
+	}
+	const envTrimmed = env?.trim() ?? "";
+	if (envTrimmed !== "") return envTrimmed;
+	return "127.0.0.1";
+}
+/**
 * Resolve the address the server will *actually* bind to for the startup banner
 * (Issue 04).
 *
@@ -9756,7 +9794,7 @@ async function runServer(options) {
 	const visibleModels = allModels.filter((m) => !isHiddenModel(m.id, state.showAllModels));
 	if (visibleModels.length === 0) consola.warn("All upstream models are filtered by the hardcoded blacklist. /v1/models will return an empty list, but explicit POSTs with a hidden id still pass through to upstream. Restart with --show-all-models to see the full catalogue.");
 	else consola.info(`Available models:\n${visibleModels.map((m) => formatModelInfo(m)).join("\n")}`);
-	const serverUrl = `http://${resolveClientHost(options.host, process.env.HOST)}:${options.port}`;
+	const serverUrl = `http://${resolveClientHost(options.host, void 0)}:${options.port}`;
 	if (options.claudeCode) {
 		if (visibleModels.length === 0) {
 			consola.error("--claude-code interactive setup needs at least one visible model. Restart with --show-all-models or update src/lib/hidden-models.ts.");
@@ -9792,7 +9830,7 @@ async function runServer(options) {
 	consola.box(`🌐 Usage Viewer: https://ericc-ch.github.io/copilot-api?endpoint=${serverUrl}/usage${options.history ? `\n📜 History UI: ${serverUrl}/history` : ""}`);
 	for (const line of buildStartupAuthLines({
 		source: options.apiKeySource,
-		bindAddress: resolveBindAddress(options.host, process.env.HOST)
+		bindAddress: resolveBindAddress(options.host, void 0)
 	})) process.stdout.write(`${line}\n`);
 	setupShutdownHandlers();
 	setServerInstance(serve({
@@ -9842,7 +9880,7 @@ const start = defineCommand({
 		host: {
 			alias: "H",
 			type: "string",
-			description: "Host/interface to bind to (e.g., 127.0.0.1 for localhost only, 0.0.0.0 for all interfaces)"
+			description: "Host/interface to bind to. Default: 127.0.0.1 (loopback only); pass 0.0.0.0 to bind all interfaces. Falls back to the HOST env var when the flag is omitted."
 		},
 		verbose: {
 			alias: "v",
@@ -9968,7 +10006,7 @@ const start = defineCommand({
 		});
 		return runServer({
 			port: Number.parseInt(args.port, 10),
-			host: args.host,
+			host: resolveBindHost(args.host, process.env.HOST),
 			verbose: args.verbose,
 			accountType: args["account-type"],
 			manual: args.manual,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dianshuv/copilot-api",
-  "version": "0.10.1",
+  "version": "0.11.0",
   "description": "Turn GitHub Copilot into OpenAI/Anthropic API compatible server. Usable with Claude Code!",
   "author": "dianshuv",
   "type": "module",