pi-keyrouter 0.2.1 → 0.2.3

package/README.md

@@ -110,7 +110,15 @@ Every key switch notifies the user with a Box widget:
 
 ## 🔧 Config
 
-`~/.pi/keyrouter.json` (or `<cwd>/.soly/keyrouter.json`, `<cwd>/.pi/keyrouter.json`).
+**`~/.pi/keyrouter.json` only** (user-level, never project-scoped).
+
+- Windows: `%USERPROFILE%\.pi\keyrouter.json`
+- macOS/Linux: `~/.pi/keyrouter.json`
+
+Config is global because API keys are personal credentials — they do not
+belong inside a project directory. Project-local `keyrouter.json` files are
+**deliberately ignored** (security: prevents a malicious repo from overriding
+your real keys).
 
 ```json5
 {

package/config.ts

@@ -2,10 +2,13 @@
 // config.ts — load key router config from disk
 // =============================================================================
 //
-// Looks in this order (first hit wins):
-// 1. <cwd>/.pi/keyrouter.json      — project override
-// 2. <cwd>/.soly/keyrouter.json    — soly convention
-// 3. ~/.pi/keyrouter.json          — user-level default
+// Config is GLOBAL (user-level), never project-scoped. API keys are personal
+// credentials that do not belong inside a project directory (risk of leaking
+// via git, shared repos, etc.).
+//
+// Single location: ~/.pi/keyrouter.json
+//   - Windows: %USERPROFILE%\.pi\keyrouter.json
+//   - macOS/Linux: ~/.pi/keyrouter.json
 //
 // Schema:
 // {
@@ -28,8 +31,6 @@ import * as os from "node:os";
 import * as path from "node:path";
 import type { KeyRouterConfig } from "./types.ts";
 
-const CONFIG_FILENAMES = ["keyrouter.json"];
-
 export function defaultConfig(): KeyRouterConfig {
 	return {
 		providers: [],
@@ -38,33 +39,38 @@ export function defaultConfig(): KeyRouterConfig {
 	};
 }
 
-export function loadConfig(cwd: string, home?: string): KeyRouterConfig {
+/**
+ * Resolve the config path. Always under the user profile (~/.pi/), never
+ * project-scoped. The `cwd` argument is accepted for API symmetry but
+ * ignored — keys are global.
+ *
+ * @param _cwd ignored — config is always user-level
+ * @param home override home dir (for testing)
+ */
+export function configPath(_cwd?: string, home?: string): string {
 	const homeDir = home ?? os.homedir();
-	const candidates: string[] = [];
-	for (const dir of [
-		path.join(cwd, ".soly"),
-		path.join(cwd, ".pi"),
-		cwd,
-		path.join(homeDir, ".soly"),
-		path.join(homeDir, ".pi"),
-		homeDir,
-	]) {
-		for (const name of CONFIG_FILENAMES) {
-			candidates.push(path.join(dir, name));
-		}
-	}
-	for (const file of candidates) {
-		if (fs.existsSync(file)) {
-			try {
-				const raw = fs.readFileSync(file, "utf-8");
-				const parsed = JSON.parse(raw) as Partial<KeyRouterConfig>;
-				return normalize(parsed);
-			} catch {
-				// bad config — fall through to default
-			}
-		}
+	return path.join(homeDir, ".pi", "keyrouter.json");
+}
+
+/**
+ * Path displayed in error messages / /keyrouter status so the user can see
+ * exactly where we're looking.
+ */
+export function configSearchPaths(): string[] {
+	return [configPath()];
+}
+
+export function loadConfig(_cwd?: string, home?: string): KeyRouterConfig {
+	const file = configPath(undefined, home);
+	if (!fs.existsSync(file)) return defaultConfig();
+	try {
+		const raw = fs.readFileSync(file, "utf-8");
+		const parsed = JSON.parse(raw) as Partial<KeyRouterConfig>;
+		return normalize(parsed);
+	} catch {
+		// bad config — fall through to default
+		return defaultConfig();
 	}
-	return defaultConfig();
 }
 
 function normalize(input: Partial<KeyRouterConfig>): KeyRouterConfig {

package/index.ts

@@ -28,7 +28,7 @@
 //   /reload
 
 import type { ExtensionAPI } from "@earendil-works/pi-coding-agent";
-import { loadConfig } from "./config.ts";
+import { loadConfig, configPath } from "./config.ts";
 import {
 	initKeyStates,
 	isAvailable,
@@ -49,16 +49,22 @@ export default function keyRouterExtension(pi: ExtensionAPI): void {
 	let notify: ((text: string, level: "info" | "warning" | "error") => void) | undefined;
 	let activationNotified = false;
 
-	function ensureRuntime(providerName: string, cfg: KeyRouterConfig): ProviderRuntime | undefined {
-		let rt = runtimes.get(providerName);
+	/**
+	 * Get-or-create the runtime for a provider. Keyed by the RESOLVED
+	 * name (the authStorage id, e.g. "zai"), but populated from the
+	 * provider config passed in directly (avoids name-mismatch bugs).
+	 */
+	function ensureRuntime(
+		resolvedName: string,
+		providerCfg: { keys: ReadonlyArray<{ name: string; value: string }> },
+	): ProviderRuntime {
+		let rt = runtimes.get(resolvedName);
 		if (rt) return rt;
-		const providerCfg = cfg.providers.find((p) => p.name === providerName);
-		if (!providerCfg) return undefined;
 		rt = {
 			keys: initKeyStates(providerCfg.keys),
 			currentIndex: -1,
 		};
-		runtimes.set(providerName, rt);
+		runtimes.set(resolvedName, rt);
 		return rt;
 	}
 
@@ -82,15 +88,15 @@ export default function keyRouterExtension(pi: ExtensionAPI): void {
 		const authStorage = ctx.modelRegistry.authStorage;
 		let newlyBootstrapped = 0;
 		for (const p of config.providers) {
-			const providerName = resolveProviderName(p.name);
+			const resolvedName = resolveProviderName(p.name);
 			// Skip providers we've already bootstrapped
-			if (runtimes.has(providerName)) continue;
-			if (bootstrap(providerName)) {
-				const rt = runtimes.get(providerName);
+			if (runtimes.has(resolvedName)) continue;
+			if (bootstrap(resolvedName, p)) {
+				const rt = runtimes.get(resolvedName);
 				if (rt && rt.currentIndex >= 0) {
 					const key = rt.keys[rt.currentIndex];
 					if (key) {
-						authStorage.setRuntimeApiKey(providerName, key.value);
+						authStorage.setRuntimeApiKey(resolvedName, key.value);
 						newlyBootstrapped++;
 					}
 				}
@@ -107,11 +113,11 @@ export default function keyRouterExtension(pi: ExtensionAPI): void {
 	}
 
 	/** Set the initial key for a provider on first use. */
-	function bootstrap(providerName: string): boolean {
-		const cfg = config;
-		if (!cfg) return false;
-		const rt = ensureRuntime(providerName, cfg);
-		if (!rt) return false;
+	function bootstrap(
+		resolvedName: string,
+		providerCfg: { keys: ReadonlyArray<{ name: string; value: string }> },
+	): boolean {
+		const rt = ensureRuntime(resolvedName, providerCfg);
 		if (rt.currentIndex >= 0) return true; // already bootstrapped
 		const idx = pickNextKey(rt.keys, 0, Date.now());
 		if (idx < 0) return false;
@@ -237,8 +243,8 @@ export default function keyRouterExtension(pi: ExtensionAPI): void {
 				}
 				if (!config || runtimes.size === 0) {
 					ctx.ui.notify(
-						"🔑 keyrouter: not active — no providers in ~/.pi/keyrouter.json " +
-							"(checked cwd/.soly, cwd/.pi, cwd, ~/.soly, ~/.pi, ~)",
+						`🔑 keyrouter: not active — no ~/.pi/keyrouter.json found ` +
+							`(expected at ${configPath()}). Config is user-level only, never project-scoped.`,
 						"warning",
 					);
 					return;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pi-keyrouter",
-  "version": "0.2.1",
+  "version": "0.2.3",
   "description": "API key rotation for pi-coding-agent. Multiple keys per provider, automatic 429/401 fallback, max-retries guard.",
   "type": "module",
   "main": "index.ts",