pi-omlx-picker 0.2.0 → 0.2.2

package/.assets/demo.tape

@@ -0,0 +1,31 @@
+Output demo.gif
+
+# Visual Settings
+Set FontSize 15
+Set Width 900
+Set Height 500
+Set Padding 20
+Set Theme "Catppuccin Mocha"
+Set WindowBar Colorful
+
+Sleep 1s
+
+Type "pi"
+Enter
+Sleep 1.5s
+
+Type "/mo"
+Sleep 1.5s
+
+Enter
+Sleep 1.5s
+
+Down
+Sleep 500ms
+Down
+Sleep 500ms
+Up
+Sleep 500ms
+
+Enter
+Sleep 3s

package/CONTRIBUTING.md

@@ -0,0 +1,52 @@
+# Contributing
+
+Local development for `pi-omlx-picker`. User config: [docs/CONFIGURATION.md](./docs/CONFIGURATION.md).
+
+## Setup
+
+```sh
+npm install
+mise run verify
+```
+
+A live OMLX server is needed for `mise run smoke:omlx` and `mise run verify:live`.
+
+## Tasks
+
+Run via [`mise`](https://mise.jdx.dev/):
+
+- `mise run verify` — Biome, TypeScript type checking, unit tests.
+- `mise run smoke:omlx` — live OMLX probe: reasoning model, non-thinking model, tool-flow request.
+- `mise run verify:live` — typecheck, unit tests, and live smoke (skips Biome; run `mise run verify` first if you want lint coverage).
+- `mise run debug:omlx` — OMLX config, model path, template, log, and cache diagnostics. Pass model names after `--` to narrow, e.g. `mise run debug:omlx -- opus sonnet`.
+- `mise run debug:pi` — Pi install, config, session, log, and cache diagnostics. Pass `install`, `config`, `sessions`, `logs`, or `cache` after `--`.
+- `mise run debug:pi -- timeline <session-id|session-file|iso-time>` — Pi provider + OMLX server + changed-files window around a stuck turn. Use `--minutes=N` to set the window (default 3).
+
+## Triage order
+
+1. Read the latest provider events in `log/provider-debug.log` (or `~/.pi/packages/pi-omlx-picker/log/provider-debug.log` when installed via Pi). Look for `stream_first_delta_timeout`, `assistant_stop_diagnosis`, and the most recent `before_provider_request` / `after_provider_response` pair. The latest `mise run smoke:omlx` proof lives in `log/smoke-test/<iso-timestamp>.json`.
+2. Inspect Pi host state: `mise run debug:pi`.
+3. Inspect OMLX config and model files: `mise run debug:omlx`.
+4. Run live smoke: `mise run smoke:omlx`.
+5. Check upstream OMLX repo releases and issues before writing local workarounds.
+6. Only then change code.
+
+Most fixes are upstream (OMLX `model_settings.json`, `chat_template.jinja`), not in Pi-side code. New-session-OK plus takeover-broken means session state, not model capacity.
+
+## Failure families
+
+```text
+symptom
+  ├─ package didn't load, wrong install, stale session, compaction, takeover
+  │   └─ mise run debug:pi
+  ├─ model alias, model settings, template, rope config, OMLX/HF cache
+  │   └─ mise run debug:omlx
+  ├─ live model request behavior
+  │   └─ mise run smoke:omlx
+  ├─ new session good, takeover bad
+  │   └─ mise run debug:pi -- sessions, then compare model_settings.json and chat_template.jinja
+  ├─ local checks pass but live smoke fails
+  │   └─ check upstream OMLX repo, releases, and issues
+  └─ model not appearing in Pi /model list
+      └─ check OMLX_BASE_URL is reachable, then mise run debug:omlx
+```

package/README.md

@@ -1,41 +1,31 @@
 # Pi OMLX Picker
 
-Pi extension that discovers models from a local [OMLX](https://github.com/Open-Model-Lookup-Exchange) server and registers them as a native Pi provider. Switch models with Pi's built-in `/model` command.
+> Seamlessly integrate your local [oMLX](https://github.com/jundot/omlx) models into Pi.
 
-## Install
+This extension discovers models from a local OMLX server and registers them as native Pi providers. Switch between your local and remote models effortlessly using Pi's built-in `/model` command.
 
-```sh
-pi install npm:pi-omlx-picker
-```
-
-## Configure
-
-Set these env vars (or copy `.env-example` to `.env`):
+![Pi OMLX Picker Demo](./.assets/demo.gif)
 
-```sh
-export OMLX_BASE_URL="http://127.0.0.1:8008/v1"
-export OMLX_API_KEY="omlx-..."
-```
+## ✨ Features
 
-If either is missing, the provider is skipped and Pi logs a message on startup.
+* **Zero-Friction Discovery:** Automatically fetches and registers available OMLX models on startup.
+* **Native Integration:** Models show up in the standard `/model` menu—no custom commands needed for chat.
+* **Smart Overrides:** Applies per-request thinking controls based on each model's `thinkingDefault` metadata.
 
-Optionally override the model metadata path (default: `~/.omlx/model_settings.json`):
+## 📦 Installation
 
 ```sh
-export OMLX_MODEL_SETTINGS_PATH="/path/to/model_settings.json"
+pi install npm:pi-omlx-picker
 ```
 
-## How it works
+## 🚀 Quick Start
 
-On startup, the extension fetches available models from OMLX, merges local `model_settings.json` metadata, and registers an `omlx` provider in Pi. Thinking controls are applied per-request based on each model's `thinkingDefault`.
+1. Run `/omlx-login` in Pi.
+2. Paste your OMLX base URL and API key when prompted.
+3. Type `/model` to see and select your OMLX models.
 
-## Debugging
+Re-run `/omlx-login` to update credentials.
 
-```sh
-mise run debug:omlx        # OMLX config, model path, template, cache
-mise run debug:pi          # Pi install, config, session, log, cache
-mise run verify            # Biome + typecheck + unit tests
-mise run smoke:omlx        # Live smoke test against a running OMLX server
-```
+## ⚙️ Configuration
 
-See [docs/DEBUG.md](docs/DEBUG.md) for triage order.
+Env-var overrides, model metadata overlay, and stream timeout knobs are documented in [docs/CONFIGURATION.md](./docs/CONFIGURATION.md).

package/index.ts

@@ -1,10 +1,11 @@
 import type { ExtensionAPI } from "@mariozechner/pi-coding-agent";
+import { PROVIDER_KEY, saveOmlxCredential } from "./src/auth-storage.ts";
 import { fetchModels, resolveLocalModelSettingsPath, type OmlxModel } from "./src/catalog.ts";
-import { loadConfig, MissingEnvError, type OmlxConfig } from "./src/config.ts";
+import { applyStoredCredentialToEnv, loadConfig, MissingEnvError, normalizeBaseUrl, type OmlxConfig } from "./src/config.ts";
 import { toProviderConfig } from "./src/provider.ts";
 import { applyOmlxThinkingControls } from "./src/thinking.ts";
 
-const PROVIDER = "omlx";
+const PROVIDER = PROVIDER_KEY;
 const EXTENSION_SINGLETON_KEY = Symbol.for("pi-omlx-picker/loaded");
 
 interface State {
@@ -30,6 +31,7 @@ export default async function (pi: ExtensionAPI): Promise<void> {
 		modelSettingsPath: undefined,
 	};
 
+	applyStoredCredentialToEnv();
 	await refreshProvider(pi, state);
 
 	pi.on("before_provider_request", (event, ctx) => {
@@ -37,8 +39,45 @@ export default async function (pi: ExtensionAPI): Promise<void> {
 		const activeModel = findCatalogModel(state, ctx.model.id);
 		return applyOmlxThinkingControls(event.payload, pi.getThinkingLevel(), activeModel?.thinkingDefault);
 	});
+
+	pi.registerCommand("omlx-login", {
+		description: "Sign in to OMLX (set base URL and API key)",
+		handler: async (_args, ctx) => {
+			const baseUrlInput = await ctx.ui.input("OMLX base URL", "http://127.0.0.1:8000/v1");
+			if (!baseUrlInput) return;
+			const apiKey = await ctx.ui.input("OMLX API key", "omlx-...");
+			if (!apiKey) return;
+
+			let baseUrl: string;
+			try {
+				baseUrl = normalizeBaseUrl(baseUrlInput);
+			} catch (err) {
+				ctx.ui.notify(`Invalid base URL: ${err instanceof Error ? err.message : String(err)}`, "error");
+				return;
+			}
+
+			ctx.ui.notify("Validating OMLX credentials…", "info");
+			try {
+				await fetchModels(baseUrl, apiKey, { timeoutMs: VALIDATE_TIMEOUT_MS });
+			} catch (err) {
+				ctx.ui.notify(`OMLX login failed: ${err instanceof Error ? err.message : String(err)}`, "error");
+				return;
+			}
+
+			saveOmlxCredential(baseUrl, apiKey);
+			process.env.OMLX_BASE_URL = baseUrl;
+			process.env.OMLX_API_KEY = apiKey;
+			await refreshProvider(pi, state);
+			const message = state.registered
+				? `OMLX connected — ${state.catalog.length} models available`
+				: `OMLX login saved but provider failed: ${state.lastError ?? "unknown error"}`;
+			ctx.ui.notify(message, state.registered ? "info" : "warning");
+		},
+	});
 }
 
+const VALIDATE_TIMEOUT_MS = 10_000;
+
 function clearRegisteredProvider(pi: ExtensionAPI, state: State): void {
 	if (state.registered) {
 		pi.unregisterProvider(PROVIDER);

package/package.json

@@ -1,25 +1,25 @@
 {
-  "name": "pi-omlx-picker",
-  "version": "0.2.0",
-  "type": "module",
-  "description": "Pi extension that maps OMLX model settings into native Pi model metadata.",
-  "license": "MIT",
-  "scripts": {
-    "test": "node --import tsx --test 'test/*.test.ts'",
-    "debug:omlx": "tsx scripts/debug-omlx.ts",
-    "debug:pi": "tsx scripts/debug-pi.ts",
-    "smoke:omlx": "tsx scripts/smoke-live-omlx.ts",
-    "typecheck": "tsc --noEmit"
-  },
-  "pi": {
-    "extensions": [
-      "./index.ts"
-    ]
-  },
-  "devDependencies": {
-    "@mariozechner/pi-ai": "^0.73.1",
-    "@mariozechner/pi-coding-agent": "*",
-    "tsx": "^4.7.0",
-    "typescript": "^6.0.3"
-  }
+    "name": "pi-omlx-picker",
+    "version": "0.2.2",
+    "type": "module",
+    "description": "Pi extension that discovers models from a local OMLX server and registers them as a native Pi provider.",
+    "license": "MIT",
+    "scripts": {
+        "test": "node --import tsx --test 'test/*.test.ts'",
+        "debug:omlx": "tsx scripts/debug-omlx.ts",
+        "debug:pi": "tsx scripts/debug-pi.ts",
+        "smoke:omlx": "tsx scripts/smoke-live-omlx.ts",
+        "typecheck": "tsc --noEmit"
+    },
+    "pi": {
+        "extensions": [
+            "./index.ts"
+        ]
+    },
+    "devDependencies": {
+        "@mariozechner/pi-ai": "^0.73.1",
+        "@mariozechner/pi-coding-agent": "*",
+        "tsx": "^4.7.0",
+        "typescript": "^6.0.3"
+    }
 }

package/src/auth-storage.ts

@@ -0,0 +1,41 @@
+import {
+	type ApiKeyCredential,
+	AuthStorage,
+} from "@mariozechner/pi-coding-agent";
+
+export const PROVIDER_KEY = "omlx";
+
+export interface OmlxStoredCredential {
+	baseUrl: string;
+	apiKey: string;
+}
+
+type OmlxApiKeyCredential = ApiKeyCredential & { baseUrl?: string };
+
+let storage: AuthStorage | undefined;
+function getStorage(): AuthStorage {
+	if (!storage) storage = AuthStorage.create();
+	return storage;
+}
+
+export function _setStorageForTesting(s: AuthStorage | undefined): void {
+	storage = s;
+}
+
+export function loadOmlxCredential(): OmlxStoredCredential | undefined {
+	const cred = getStorage().get(PROVIDER_KEY) as
+		| OmlxApiKeyCredential
+		| undefined;
+	if (!cred || cred.type !== "api_key") return undefined;
+	if (!cred.baseUrl || !cred.key) return undefined;
+	return { baseUrl: cred.baseUrl, apiKey: cred.key };
+}
+
+export function saveOmlxCredential(baseUrl: string, apiKey: string): void {
+	const cred: OmlxApiKeyCredential = { type: "api_key", key: apiKey, baseUrl };
+	getStorage().set(PROVIDER_KEY, cred);
+}
+
+export function deleteOmlxCredential(): void {
+	getStorage().remove(PROVIDER_KEY);
+}

package/src/catalog.ts

@@ -545,4 +545,3 @@ function compactObject(
 	});
 	return entries.length > 0 ? Object.fromEntries(entries) : undefined;
 }
-

package/src/config.ts

@@ -1,3 +1,5 @@
+import { loadOmlxCredential } from "./auth-storage.ts";
+
 export interface OmlxConfig {
 	apiRoot: string;
 	apiKeyEnvVar: string;
@@ -25,3 +27,22 @@ export function loadConfig(env: NodeJS.ProcessEnv = process.env): OmlxConfig {
 		apiKeyEnvVar: "OMLX_API_KEY",
 	};
 }
+
+// Env vars win over stored creds so CI and per-shell overrides work.
+export function applyStoredCredentialToEnv(
+	env: NodeJS.ProcessEnv = process.env,
+): boolean {
+	if (env.OMLX_BASE_URL && env.OMLX_API_KEY) return false;
+	const stored = loadOmlxCredential();
+	if (!stored) return false;
+	let applied = false;
+	if (!env.OMLX_BASE_URL) {
+		env.OMLX_BASE_URL = stored.baseUrl;
+		applied = true;
+	}
+	if (!env.OMLX_API_KEY) {
+		env.OMLX_API_KEY = stored.apiKey;
+		applied = true;
+	}
+	return applied;
+}