free-coding-models 0.5.64 → 0.5.66

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (40) hide show
  1. package/README.md +550 -593
  2. package/changelog/v0.5.65.md +35 -0
  3. package/changelog/v0.5.66.md +55 -0
  4. package/package.json +3 -3
  5. package/src/core/ping.js +16 -0
  6. package/src/core/probe-cache.js +54 -5
  7. package/src/core/provider-cooldown.js +185 -0
  8. package/src/tui/app.js +18 -0
  9. package/src/tui/render-table.js +35 -2
  10. package/src/tui/tui-state.js +7 -0
  11. package/web/dist/assets/{index-5S_yM5SF.js → index-BhjFwk1y.js} +2 -2
  12. package/web/dist/favicon.ico +0 -0
  13. package/web/dist/favicons/apple-touch-icon.png +0 -0
  14. package/web/dist/favicons/favicon-16x16.png +0 -0
  15. package/web/dist/favicons/favicon-192x192.png +0 -0
  16. package/web/dist/favicons/favicon-32x32.png +0 -0
  17. package/web/dist/favicons/favicon-48x48.png +0 -0
  18. package/web/dist/favicons/favicon-512x512.png +0 -0
  19. package/web/dist/favicons/favicon-96x96.png +0 -0
  20. package/web/dist/favicons/favicon.ico +0 -0
  21. package/web/dist/favicons/mstile-150x150.png +0 -0
  22. package/web/dist/favicons/mstile-310x150.png +0 -0
  23. package/web/dist/favicons/mstile-310x310.png +0 -0
  24. package/web/dist/favicons/mstile-512x512.png +0 -0
  25. package/web/dist/favicons/mstile-70x70.png +0 -0
  26. package/web/dist/index.html +1 -1
  27. package/web/public/favicon.ico +0 -0
  28. package/web/public/favicons/apple-touch-icon.png +0 -0
  29. package/web/public/favicons/favicon-16x16.png +0 -0
  30. package/web/public/favicons/favicon-192x192.png +0 -0
  31. package/web/public/favicons/favicon-32x32.png +0 -0
  32. package/web/public/favicons/favicon-48x48.png +0 -0
  33. package/web/public/favicons/favicon-512x512.png +0 -0
  34. package/web/public/favicons/favicon-96x96.png +0 -0
  35. package/web/public/favicons/favicon.ico +0 -0
  36. package/web/public/favicons/mstile-150x150.png +0 -0
  37. package/web/public/favicons/mstile-310x150.png +0 -0
  38. package/web/public/favicons/mstile-310x310.png +0 -0
  39. package/web/public/favicons/mstile-512x512.png +0 -0
  40. package/web/public/favicons/mstile-70x70.png +0 -0
package/README.md CHANGED
@@ -6,10 +6,9 @@
6
6
 
7
7
  <p align="center">
8
8
  <strong>Find the fastest free coding model in seconds</strong><br>
9
- Track ~222 models across 20 trusted free or free-limited AI providers in real time<br><br>
10
- <strong>Install Free API endpoints to your favorite AI coding tools:</strong><br>
11
- OpenCode CLI / Desktop / WebUI, OpenClaw, Crush, Goose, Aider, Kilo CLI, Qwen Code, OpenHands, Amp, Hermes, Continue, Cline, Xcode, Pi, ZCode and more...<br><br>
12
- <strong>Use Kimi K2, DeepSeek V3, GPT-OSS, Qwen3, MiniMax M3, GLM, Llama 4, Gemma 4, Devstral and more — for free</strong>
9
+ Track ~222 models across 20 trusted free or free-limited AI providers in real time, then install the one you pick straight into your favorite coding tool.<br><br>
10
+ <strong>Works with:</strong> OpenCode CLI / Desktop / WebUI, OpenClaw, Crush, Goose, Aider, Kilo CLI, Qwen Code, OpenHands, Amp, Hermes, Continue, Cline, Xcode, Pi, ZCode, ForgeCode, Copilot and more.<br><br>
11
+ <strong>Use Kimi K2, DeepSeek V3/V4, GPT-OSS, Qwen3, MiniMax M3, GLM, Llama 4, Gemma 4, Devstral and more for free</strong>
13
12
  </p>
14
13
 
15
14
  <p align="center">
@@ -26,21 +25,23 @@ free-coding-models
26
25
  ```
27
26
 
28
27
  <p align="center">
29
- create a free account on one of the <a href="#-list-of-free-ai-providers">providers</a>
28
+ <sub>Then create a free account on one of the <a href="#-free-ai-providers">20 providers</a> to grab an API key.</sub>
30
29
  </p>
31
30
 
32
31
  <p align="center">
33
32
  <a href="#-why-this-tool">💡 Why</a> •
34
33
  <a href="#-quick-start">⚡ Quick Start</a> •
35
- <a href="#-list-of-free-ai-providers">🟢 Providers</a> •
36
- <a href="#-usage">🚀 Usage</a> •
37
- <a href="#-tui-keys">⌨️ TUI Keys</a> •
38
- <a href="#-features">✨ Features</a> •
34
+ <a href="#-free-ai-providers">🟢 Providers</a> •
35
+ <a href="#-the-terminal-ui-tui">🎛️ TUI</a> •
36
+ <a href="#-the-web-dashboard">🌐 Web</a> •
37
+ <a href="#-agent-extensions">🔌 Extensions</a> •
38
+ <a href="#-the-smart-model-router">🔀 Router</a> •
39
+ <a href="#-reference">📖 Reference</a> •
39
40
  <a href="#-contributing">📋 Contributing</a> •
40
41
  <a href="#️-model-licensing--commercial-use">⚖️ Licensing</a> •
41
42
  <a href="#-telemetry">📊 Telemetry</a> •
42
43
  <a href="#️-security--trust">🛡️ Security</a> •
43
- <a href="#-other-free-ai-resources">🆓 Other Free AI Resources</a>
44
+ <a href="#-other-free-ai-resources">🆓 More resources</a>
44
45
  </p>
45
46
 
46
47
  <p align="center">
@@ -59,21 +60,112 @@ free-coding-models
59
60
 
60
61
  ## 💡 Why this tool?
61
62
 
62
- There are **~222 cataloged free or free-limited coding models** across 20 vetted providers. Which one is fastest right now? Which one is actually stable versus just lucky on the last ping?
63
+ There are **~222 cataloged free or free-limited coding models** across 20 vetted providers. Which one is fastest *right now*? Which one is actually stable, versus just lucky on the last ping?
63
64
 
64
- This CLI pings them all in parallel, shows live latency, and calculates a **live Stability Score (0-100)**. Average latency alone is misleading if a model randomly spikes to 6 seconds; the stability score measures true reliability by combining **p95 latency** (30%), **jitter/variance** (30%), **spike rate** (20%), and **uptime** (20%).
65
+ `free-coding-models` (FCM) answers that by pinging every model in parallel, showing live latency, and computing a **live Stability Score (0100)**. Average latency alone is misleading a model that randomly spikes to 6 seconds isn't reliable. The stability score combines **p95 latency** (30%), **jitter/variance** (30%), **spike rate** (20%), and **uptime** (20%) to measure true reliability.
65
66
 
66
- It then writes the model you pick directly into your coding tool's config — so you go from "which model?" to "coding" in under 10 seconds.
67
+ Once you've picked a model, FCM writes it directly into your coding tool's config — so you go from *"which model?"* to *"coding"* in under 10 seconds.
68
+
69
+ **FCM ships as four surfaces**, all powered by the same engine:
70
+
71
+ | Surface | What it is | When to use it |
72
+ |---|---|---|
73
+ | 🎛️ **TUI** | The interactive terminal dashboard | The default. Live ranking, pick + launch a model. |
74
+ | 🌐 **Web Dashboard** | A browser control center | Browse from your browser, share filtered views, run headless in Docker. |
75
+ | 🔌 **Extensions** | OpenCode & Pi agent plugins | Hot-swap models mid-session without leaving your agent. |
76
+ | 🔀 **Router** | A local OpenAI-compatible daemon | One localhost endpoint that auto-fails-over between free models. |
77
+
78
+ > The TUI and Web Dashboard are the **core** of the product — that's where most users live. Extensions and the Router build on top of the same engine and are covered later in this doc.
67
79
 
68
80
  ---
69
81
 
70
82
  ## ⚡ Quick Start
71
83
 
72
- ### 🟢 List of Free AI Providers
84
+ From zero to "coding with a free model" in about 2 minutes — then a fast tour of the coolest features. Each step links to the full section when you want to go deeper.
85
+
86
+ ### ① Install
87
+
88
+ ```bash
89
+ npm install -g free-coding-models
90
+ free-coding-models --help # sanity check — prints every flag
91
+ ```
92
+
93
+ Requires **Node.js 18+**. That's the only prerequisite — FCM has a single runtime dependency (`chalk`), no native build step, and never needs `sudo`. Update later at any time with `npm install -g free-coding-models@latest` (or `Shift+U` inside the app).
94
+
95
+ ### ② Grab one free API key
96
+
97
+ FCM tracks ~222 models across 20 providers, but you only need **one key** to start. The fastest sign-ups (no credit card, instant key):
98
+
99
+ - **Groq** → [console.groq.com/keys](https://console.groq.com/keys) — Llama 4, GPT-OSS, blazing fast
100
+ - **Cerebras** → [cloud.cerebras.ai](https://cloud.cerebras.ai) — the lowest latency in the whole catalog
101
+ - **NVIDIA NIM** → [build.nvidia.com](https://build.nvidia.com) — 27 models, the biggest free variety
73
102
 
74
- Create a free account on one provider below to get started. A few providers (`Kilo`, `LLM7`, OVHcloud sandbox) can also answer without a key, with tighter shared limits.
103
+ 👉 See the full [**provider table**](#-free-ai-providers) for limits, tiers, and env vars. You can add more keys at any time from inside the app (**`P`** Settings) one is enough to begin.
75
104
 
76
- **~222 coding models** across 20 active providers, ranked by practical free-tier usefulness.
105
+ ### Launch & paste your key
106
+
107
+ ```bash
108
+ free-coding-models
109
+ ```
110
+
111
+ On first run FCM prompts you for API keys. **Paste yours** (or press `Enter` to skip — you'll still see keyless latency rows marked 🔑 NO KEY, and can add keys later with **`P`**). Models start pinging in parallel; rows light up green ✅ as they respond. The default view shows only the providers you have keys for, so the table is calm, not overwhelming.
112
+
113
+ ### ④ Pick a model & launch your tool
114
+
115
+ ```
116
+ ↑↓ navigate the live table → Enter to launch
117
+ ```
118
+
119
+ The model you land on is written straight into your tool's config **and the tool opens immediately** — that's the whole trick, start to finish in seconds. The default target is **OpenCode CLI**; pre-target another tool from the command line or cycle it live with **`Z`**:
120
+
121
+ ```bash
122
+ free-coding-models --goose --tier S # Goose, pre-filtered to S-tier only
123
+ free-coding-models --crush --origin groq # Crush, Groq models only
124
+ free-coding-models --aider # Aider
125
+ free-coding-models --opencode --premium # OpenCode, elite-focused preset
126
+ ```
127
+
128
+ > 💡 **Missing tool?** If the target CLI isn't installed, FCM catches it, offers a one-line install prompt, installs the official global binary, then resumes the exact same launch automatically.
129
+ >
130
+ > 💡 **Headless?** Skip the TUI entirely: `free-coding-models --tier S --json | jq -r '.[0].modelId'` prints the fastest S-tier model ID for scripts. Or `free-coding-models --fiable` waits 10s and prints the single most reliable model right now.
131
+
132
+ → Full keybindings & workflows: [The Terminal UI (TUI)](#-the-terminal-ui-tui)
133
+
134
+ ### ⑤ The 30-second cool tour 👇
135
+
136
+ You're in. Try these next — they're the features that make FCM feel good:
137
+
138
+ | Press | What happens | Go deeper |
139
+ |---|---|---|
140
+ | **`Ctrl+P`** | Open the ⚡️ **Command Palette** — fuzzy-search every filter, sort, and action in the app | [TUI](#-the-terminal-ui-tui) |
141
+ | **`Q`** | **Smart Recommend** — answer 3 questions, get your Top 3 models picked for you | [TUI](#-the-terminal-ui-tui) |
142
+ | **`Ctrl+A`** / **`Ctrl+U`** | Run a real **AI Speed Test** on one model / all visible models (splits into Latency + TPS) | [TUI](#-the-terminal-ui-tui) |
143
+ | **`F`** then **`Y`** | **Favorite** a model, then **pin** your favorites to the top so they never scroll away | [TUI](#-the-terminal-ui-tui) |
144
+ | **`Z`** | **Cycle tool** (OpenCode → OpenClaw → Crush → Goose → …) without restarting | [TUI](#-the-terminal-ui-tui) |
145
+ | **`G`** | **Cycle theme** (Auto → Dark → Light) if your terminal fights the colors | [TUI](#-the-terminal-ui-tui) |
146
+ | **`;`** | Open the **Playground** — chat with the router right inside the TUI | [Router](#-the-smart-model-router) |
147
+
148
+ <p align="center">
149
+ <img src="https://img.shields.io/badge/USE_%E2%9A%A1%EF%B8%8F%20COMMAND%20PALETTE-CTRL%2BP-22c55e?style=for-the-badge" alt="Use ⚡️ Command Palette with Ctrl+P">
150
+ </p>
151
+
152
+ ### ⑥ Go further
153
+
154
+ Once the TUI feels familiar, FCM has three more surfaces — pick the one that matches how you work:
155
+
156
+ - 🌐 **Prefer a browser?** → `free-coding-models web` opens the realtime [**Web Dashboard**](#-the-web-dashboard) on `localhost:3333` (or run it headless in [Docker](#-the-web-dashboard)).
157
+ - 🔀 **Want one endpoint that never dies?** → `free-coding-models --daemon-bg` starts the [**Smart Model Router**](#-the-smart-model-router); point any tool at `http://localhost:19280/v1` with model `fcm` and let it auto-fail-over between free models.
158
+ - 🤖 **Live inside an agent?** → install the [**OpenCode plugin**](#-agent-extensions) or the [**Pi extension**](#-agent-extensions) to hot-swap models mid-session with a single `/fcm`.
159
+
160
+ <p align="center">
161
+ <img src="demo2.gif" alt="free-coding-models TUI demo" width="100%">
162
+ </p>
163
+
164
+ ---
165
+
166
+ ## 🟢 Free AI Providers
167
+
168
+ **~222 coding models** across 20 active providers, ranked by practical free-tier usefulness. Sign up on any one of them to get a key — you only need one to start.
77
169
 
78
170
  | # | Provider | Models | Tier range | Free tier | Env var |
79
171
  |---|----------|--------|-----------|-----------|--------|
@@ -98,14 +190,12 @@ Create a free account on one provider below to get started. A few providers (`Ki
98
190
  | 19 | [Novita AI](https://novita.ai) | 4 | S+ → S | Only zero-price live chat models included | `NOVITA_API_KEY` |
99
191
  | 20 | [Ollama Cloud](https://ollama.com/pricing) | 17 | S+ → A | Free cloud usage with session/weekly limits | `OLLAMA_API_KEY` |
100
192
 
101
- > 💡 One key is enough. Add more at any time with **`P`** inside the TUI.
102
-
103
- > 🧹 Audit cleanup: `iFlow` was removed because it shut down on April 17, 2026. `Together AI`, `Perplexity API`, `DeepInfra`, `Replicate`, `Fireworks`, `Hyperbolic`, `Hugging Face`, `SiliconFlow`, `Chutes AI` were removed from the active free catalog because they are paid, trial-credit only, too tiny to be useful, unclear as a stable free API, or tool-specific rather than a generally usable free provider. `Rovo` and `Gemini CLI` were also wiped out as tool integrations (CLI-only, not generally usable free providers).
104
-
105
- ---
193
+ > 💡 One key is enough to start. Add more at any time by pressing **`P`** inside the TUI (or via the Web Dashboard **Settings** page). A few providers (`Kilo`, `LLM7`, OVHcloud sandbox) can even answer without a key, with tighter shared limits.
106
194
 
107
195
  ### Tier scale
108
196
 
197
+ Every model is tiered by its **SWE-bench Verified** score — the industry-standard benchmark for real coding tasks.
198
+
109
199
  | Tier | SWE-bench | Best for |
110
200
  |------|-----------|----------|
111
201
  | **S+** | ≥ 70% | Complex refactors, real-world GitHub issues |
@@ -114,114 +204,196 @@ Create a free account on one provider below to get started. A few providers (`Ki
114
204
  | **A-/B+** | 30–40% | Smaller tasks, constrained infra |
115
205
  | **B/C** | < 30% | Code completion, edge/minimal setups |
116
206
 
117
- **① Install and run:**
207
+ Press **`T`** in the TUI to cycle the tier filter (All → S+ → S → … → C → All).
118
208
 
119
- ```bash
120
- npm install -g free-coding-models
121
- free-coding-models
122
- ```
209
+ ### ⚠️ Health checks consume provider quota
123
210
 
124
- On first run, you'll be prompted to enter your API key(s). You can skip providers and add more later with **`P`**.
211
+ FCM continuously health-probes every model so you see live latency, status, and verdict. When you've configured a provider's API key, **those probes are authenticated and count against that provider's daily quota**. Rate-limited providers like **OpenRouter** (50 req/day free) are the most sensitive: one overloaded model re-pinged every second can burn your quota in minutes.
125
212
 
126
- Use ⚡️ Command Palette! with **Ctrl+P**.
213
+ To protect you, FCM:
127
214
 
128
- <p align="center">
129
- <img src="https://img.shields.io/badge/USE_%E2%9A%A1%EF%B8%8F%20COMMAND%20PALETTE-CTRL%2BP-22c55e?style=for-the-badge" alt="Use ⚡️ Command Palette with Ctrl+P">
130
- </p>
215
+ - **Auto-pauses** a provider the moment its probe gets a `429` (it honors the `Retry-After` header).
216
+ - **Backs off exponentially** per failing model (30s → 1m → 2m → 5m) instead of re-pinging it every cycle.
217
+ - **Surfaces a footer chip** like `⏸ openrouter 14h` so you can see which providers are resting.
218
+
219
+ > If you don't need authenticated probes for a provider, just leave its key empty — anonymous probes still work for liveness checks on most providers, and they won't burn your personal quota.
220
+
221
+ <details>
222
+ <summary><strong>🧹 Providers removed from the catalog (and why)</strong></summary>
223
+
224
+ `iFlow` shut down on April 17, 2026. `Together AI`, `Perplexity API`, `DeepInfra`, `Replicate`, `Fireworks`, `Hyperbolic`, `Hugging Face`, `SiliconFlow`, `Chutes AI` were removed because they are paid, trial-credit only, too tiny to be useful, unclear as a stable free API, or tool-specific rather than a generally usable free provider. `Rovo` and `Gemini CLI` were removed as tool integrations (CLI-only, not generally usable free providers). The full list of free-tier providers kept *outside* the core catalog lives in [Other Free AI Resources](#-other-free-ai-resources).
225
+
226
+ </details>
131
227
 
132
228
  ---
133
229
 
134
- ## 🐳 Docker
230
+ ## 🎛️ The Terminal UI (TUI)
135
231
 
136
- Run FCM without installing Node.js using the official Docker image:
232
+ The TUI is the heart of FCM. Launch it with `free-coding-models` and you get a live, sortable table of every model — real latency, stability, verdict, and a one-key launch into your coding tool.
137
233
 
138
- > **Note:** GHCR requires authentication even for public images. Login once with:
139
- > ```bash
140
- > echo $GITHUB_TOKEN | docker login ghcr.io -u YOUR_GITHUB_USERNAME --password-stdin
141
- > ```
142
- > Or use a [personal access token](https://github.com/settings/tokens) with `read:packages` scope.
234
+ <p align="center"><video src="website/public/videos/tui-first-launch.mp4" alt="First launch ~222 models ping in parallel" autoplay muted loop playsinline width="100%"></video></p>
143
235
 
144
- ```bash
145
- # Quick start (daemon + web UI on port 19280)
146
- docker run -p 19280:19280 ghcr.io/vava-nessa/free-coding-models:latest
236
+ ### First-run flow
147
237
 
148
- # With an API key
149
- docker run -p 19280:19280 -e OPENROUTER_API_KEY=your_key ghcr.io/vava-nessa/free-coding-models:latest
238
+ 1. `free-coding-models` opens the TUI and prompts for API keys. Paste one (or skip).
239
+ 2. Models start pinging in parallel. Rows turn green ✅ as they respond.
240
+ 3. Navigate with **`↑↓`**, press **`Enter`** on the model you want — FCM writes it into your tool's config and launches the tool.
241
+
242
+ ### Common workflows
243
+
244
+ **"Give me the fastest model that actually works"**
245
+ Sort by stability with **`B`** (or **`V`** for verdict) — the top rows with 🥇🥈🥉 medals are your best bets. Models in `NO KEY` or `AUTH FAIL` are faded to 80% opacity so you instantly see what you can't use.
246
+
247
+ **"Configure OpenCode with Groq's fastest model"**
248
+ ```bash
249
+ free-coding-models --opencode --origin groq
250
+ # → navigate, press Enter. opencode.json is written and the CLI opens.
150
251
  ```
151
252
 
152
- Access the daemon web dashboard at `http://localhost:19280/` and configure your coding tool to use `http://localhost:19280/v1` with model `fcm`.
253
+ <p align="center"><video src="website/public/videos/tui-pick-and-launch.mp4" alt="Pick a model & launch — Enter writes the model and opens the tool" autoplay muted loop playsinline width="100%"></video></p>
254
+
255
+ **"Benchmark before I commit to a model"**
256
+ - **`Ctrl+A`** runs an AI Speed Test on the selected model (a real completion request — not just a ping). Results split into **AI Latency** + **TPS**.
257
+ - **`Ctrl+U`** runs the global benchmark across all visible models.
258
+ - Enable **Startup AI Speed Scan** in Settings (`P`) to run the global benchmark automatically after launch.
259
+
260
+ <p align="center"><video src="website/public/videos/tui-speed-test.mp4" alt="AI Speed Test — Ctrl+A benchmarks the selected model" autoplay muted loop playsinline width="100%"></video></p>
261
+
262
+ **"I don't know which model to pick — pick for me"**
263
+ Press **`Q`** to open **Smart Recommend**, a 3-question wizard (task type, priorities…) that returns Top 3 shared-score recommendations.
264
+
265
+ **"Keep my go-to models pinned"**
266
+ Star a model with **`F`** — favorites persist across sessions (shared with the Web Dashboard via `~/.free-coding-models.json`). Press **`Y`** to toggle **Pinned mode**: favorites stay pinned at the top and never scroll off-screen.
267
+
268
+ **"Switch tools without restarting"**
269
+ Press **`Z`** to cycle the target tool (OpenCode → OpenClaw → Crush → Goose → …). Models incompatible with the active tool get a dark-red row background so you instantly see what works.
270
+
271
+ **"My terminal theme fights the TUI colors"**
272
+ Press **`G`** to cycle **Auto → Dark → Light**. Recolors the full interface live (table, Settings, Help, overlays).
273
+
274
+ ### Keyboard reference
275
+
276
+ | Key | Action |
277
+ |-----|--------|
278
+ | `↑↓` | Navigate models |
279
+ | `Enter` | Launch the selected model in the active tool |
280
+ | `Z` | Cycle target tool |
281
+ | `T` | Cycle tier filter (All → S+ → S → … → C) |
282
+ | `D` | Cycle provider filter |
283
+ | `E` | Cycle visibility filter (`Active only → Configured only → Usable only`) |
284
+ | `X` | Clear the active custom text filter |
285
+ | `F` | Favorite / unfavorite a model |
286
+ | `Y` | Toggle favorites mode (`Normal` ↔ `Pinned + always visible`) |
287
+ | `G` | Cycle global theme (`Auto → Dark → Light`) |
288
+ | **`Ctrl+P`** | Open the ⚡️ **Command Palette** (fuzzy action launcher) |
289
+ | **`;`** | Open the **Playground** chat overlay (chat with the FCM router) |
290
+ | **`Ctrl+A`** | Run an AI Speed Test for the selected model |
291
+ | **`Ctrl+U`** | Run the Global AI Speed Test (real provider requests) |
292
+ | `R/S/C/M/O/L/A/H/V/B/U` | Sort by Rank / SWE / ContexT / Model / Origin / Last ping / Avg ping / Health / Verdict / staBility / Uptime |
293
+ | `W` | Sort by real-world score (`Real` column — see [Runtime telemetry](#-runtime-telemetry-real-world-scores)) |
294
+ | `Shift+W` | Open the Runtime Report overlay (per-model breakdown + recent calls) |
295
+ | `Shift+B` | Toggle visibility of broken models (footer shows `⚡ N cached · 🔴 M broken`) |
296
+ | `Shift+U` | Update to the latest version (when an update is available) |
297
+ | `P` | Settings (API keys, providers, updates, theme, Startup Speed Scan) |
298
+ | `Q` | Smart Recommend overlay |
299
+ | `N` | Changelog |
300
+ | `I` | Feedback / bug report |
301
+ | `K` | Help overlay |
302
+ | `Ctrl+C` | Exit |
303
+
304
+ ### Mouse reference
305
+
306
+ | Action | Result |
307
+ |--------|--------|
308
+ | **Click column header** | Sort by that column |
309
+ | **Click Tier header** | Cycle tier filter |
310
+ | **Click CLI Tools header** | Cycle tool mode |
311
+ | **Click model row** | Move cursor to model |
312
+ | **Double-click model row** | Select and launch model |
313
+ | **Right-click model row** | Toggle favorite |
314
+ | **Scroll wheel** | Navigate table / overlays / palette |
315
+ | **Click footer hotkey** | Trigger that action |
316
+ | **Click update banner** | Install latest version and relaunch |
317
+ | **Click outside modal** | Close the command palette |
318
+
319
+ → **Stability score & full column reference:** [`docs/stability.md`](./docs/stability.md)
320
+
321
+ ---
322
+
323
+ ## 🌐 The Web Dashboard
153
324
 
154
- For the full TUI-style catalog dashboard from an npm install, run:
325
+ The Web Dashboard is a real-time, browser-based control center for the same catalog — full parity with the TUI for everything that's safe to port. It's the best surface for browsing at a glance, sharing filtered views, or running FCM headless in Docker.
326
+
327
+ ### Start it
155
328
 
156
329
  ```bash
330
+ # Catalog-only dashboard on http://localhost:3333 (override with FCM_WEB_PORT)
157
331
  free-coding-models web
332
+
333
+ # Full dashboard + Smart Model Router on http://localhost:19280
334
+ free-coding-models --daemon
158
335
  ```
159
336
 
160
- This starts the realtime Web Dashboard locally, opens it in your browser, and uses `http://localhost:3333/` by default. Override the port with `FCM_WEB_PORT=3334 free-coding-models web`.
337
+ | Mode | Port | What you get |
338
+ |------|------|--------------|
339
+ | `web` (or `--web` / `--gui`) | `3333` (`FCM_WEB_PORT`) | The realtime catalog dashboard only — browse, filter, benchmark. |
340
+ | `--daemon` | `19280` (`FCM_PORT`) | Dashboard **+** the Smart Model Router API (`/v1/...`) on the same port. |
341
+ | `--daemon-bg` | `19280` | Same as `--daemon`, but detached so it keeps running after the TUI closes. |
161
342
 
162
- #### Web Dashboard features (M4 parity with TUI)
343
+ > 💡 Open the dashboard with `open http://localhost:3333` (or `19280`), or drive it headless with `chrome-devtools`.
163
344
 
164
- The local Web Dashboard is a real-time control center for the model catalog
165
- — not just a static table. The header holds every navigation entry, the
166
- model table uses **100% of the viewport width** (no left rail, no right rail),
167
- and every TUI capability that's safe to port ships behind a button or chip.
345
+ ### What's in the dashboard
168
346
 
169
- | Area | What's there |
347
+ The model table uses **100% of the viewport width** (no rails) under a sticky header + filter bar, and every TUI capability ships behind a button or chip.
348
+
349
+ | Area | Highlights |
170
350
  |---|---|
171
- | **Header** | Logo + version · primary nav (Dashboard, Settings, Analytics, Recommend, Router) · kebab menu (Help, Changelog, Install Endpoints, Installed Models) · endpoint target picker · `⌘K` command palette · AI Latency · theme · export |
172
- | **Model table** | Full-bleed (no left/right border, no margin) under the sticky header + filter bar · 17 columns, resizable widths persisted in localStorage, ⭐ star per row, 🔌 install-endpoint button per row, medal borders for top-3, dark-red row class for tool-incompatible models, click AI Lat. cell to run a per-row benchmark · table header row stays sticky while scrolling |
173
- | **Filter bar** | Sticky right below the header (always visible) · Tier / Status / Verdict / Health chip rows · Visibility dropdown (Normal / Configured only / Usable only) · Provider select · custom text filter chip with `X` clear · Reset button (TUI `N`) · ping mode (Speed / Normal / Slow / Forced) · "next ping in Xs" countdown (TUI style, always shown) |
174
- | **Stats bar** | Removed in M1 (users found it noisy; the table + chips carry the same info at a glance) |
175
- | **Detail panel** | Slide-in from the right on row click · endpoint target indicator + install-endpoint button · per-row benchmark button (TUI `Ctrl+A`) · favorite toggle (TUI `F`) + up/down reorder (TUI `Shift+↑↓`) · latency trend chart · all stats |
176
- | **Command palette** | `⌘K` / `Ctrl+P` (the only global keyboard shortcut) · fuzzy search across views, theme, ping mode, reset, export, **and the full TUI command registry** (every filter / sort / tool / page entry from `src/tui/command-palette.js`) |
177
- | **Keyboard** | `Esc` closes any modal · `Cmd+K` toggles the palette that's it. Everything else is mouse-first. |
178
- | **URL deep-linking** | `?tier=S+&sort=verdict&origin=groq&toolMode=goose&q=…` hydrates the dashboard on load **and** every filter / sort / view / endpoint target change is reflected back in the URL (debounced 80ms, `history.replaceState`). CLI flags become shareable links. |
179
- | **Favorites** | Shared with the TUI through `~/.free-coding-models.json` a star in the Web is a star in the TUI. Includes pinned+sticky display mode (TUI `Y`). |
180
- | **Help modal** | Header overflow menu → "Help" opens a full-screen modal with all the TUI's keyboard shortcuts, filter behavior, and parity notes. Live search bar. |
181
- | **Changelog modal** | Header overflow menu "Changelog" or Settings "Open Changelog" link. Two-phase (index of versions + per-version release notes). Deep-linkable to a specific version. |
182
- | **Update flow** | Header `⬆ vX.Y.Z` chip + popover with "Update now" + "What's new" (jumps to the new version's changelog entry). Polls every 5 min. |
183
- | **Settings parity** | Full Settings page: theme (auto/dark/light), favorites pinned mode, startup AI Speed Scan, shell env export, legacy proxy cleanup, per-provider **Test** key button (TUI `T` key), update row. All settings persisted to the same `~/.free-coding-models.json` the TUI uses. |
184
- | **Theme** | Tri-state `auto / dark / light` cycle (TUI `G`) — auto follows the OS preference. |
185
- | **Smart Recommend** | Header "Recommend" opens the 3-question wizard, runs the 10s analysis phase, then returns the Top 3 shared-score recommendations with Pin + install-endpoint actions. |
186
- | **Endpoint installs** | The Web never starts external tools. It writes the selected provider/model endpoint into the chosen tool config (`/api/install-endpoint`), then users start their tool themselves. |
187
- | **Router Dashboard** | Header "Router" opens a full modal with daemon start/stop, model health table with circuit breaker badges, request log, probe mode selector, quick-setup card (copy base URL + model to clipboard), **"Probe all" AI Latency/TPS benchmarking**, and a **"Test Router" mini playground** to live-route chats through the fallback chain. |
188
- | **Token Usage** | Integrated inside Analytics: today + all-time summary cards, 7-day usage bar chart, top models and top providers breakdown. |
189
- | **Installed Models** | Header overflow → "Installed Models" opens a modal that scans all tool configs (Goose, Crush, Aider, Kilo, Qwen, Pi, OpenHands, Amp) and shows configured models with soft-delete (backup saved). |
190
- | **Install Endpoints wizard** | Header overflow → "Install Endpoints" opens a 4-step wizard: pick provider → pick tool → select models → install. Writes managed provider catalogs into tool configs using the same engine as the TUI. |
191
-
192
- Roadmap items:
193
- - **M5** — Polish, accessibility, mobile hamburger nav, Lighthouse a11y ≥ 95.
194
-
195
- ### Available Image Tags
196
-
197
- | Tag | Description |
198
- |-----|-------------|
199
- | `latest` | Most recent release |
200
- | `v{major}.{minor}.{patch}` | Specific version (e.g., `v0.3.70`) |
201
- | `v{major}.{minor}` | Minor version (e.g., `v0.3`) |
202
- | `v{major}` | Major version (e.g., `v0`) |
203
-
204
- ### Environment Variables
205
-
206
- | Variable | Default | Description |
207
- |----------|---------|-------------|
208
- | `FCM_HOST` | `0.0.0.0` | Host to bind to (set `127.0.0.1` for localhost-only) |
209
- | `FCM_PORT` | `19280` | Port to listen on |
210
- | `FREE_CODING_MODELS_TELEMETRY` | `0` | Disable telemetry |
351
+ | **Header** | Logo + version · nav (Dashboard, Settings, Analytics, Recommend, Router) · kebab menu (Help, Changelog, Install Endpoints, Installed Models) · endpoint target picker · `⌘K` palette · AI Latency toggle · theme · export |
352
+ | **Model table** | 17 resizable columns (widths saved in localStorage), ⭐ star + 🔌 install per row, medal borders for top-3, dark-red rows for tool-incompatible models, click an AI Latency cell to run a per-row benchmark, sticky header |
353
+ | **Filter bar** | Tier / Status / Verdict / Health chip rows · Visibility (Normal / Configured only / Usable only) · Provider select · text filter with `X` clear · Reset (TUI `N`) · ping mode (Speed / Normal / Slow / Forced) · "next ping in Xs" countdown |
354
+ | **Detail panel** | Slide-in on row click · install-endpoint + per-row benchmark · favorite toggle + reorder (TUI `Shift+↑↓`) · latency trend chart · all stats |
355
+ | **Command palette** | `⌘K` / `Ctrl+P` the only global shortcut. Fuzzy search across views, theme, ping mode, reset, export, **and the full TUI command registry** |
356
+ | **Smart Recommend** | The 3-question wizard Top 3 shared-score recommendations with Pin + install actions |
357
+ | **Router Dashboard** | Daemon start/stop, model health table with circuit-breaker badges, request log, probe-mode selector, "Probe all" benchmark, and a **Test Router** mini-playground |
358
+ | **Token Usage** | (inside Analytics) today + all-time summary, 7-day bar chart, top models & providers breakdown |
359
+ | **Settings parity** | Theme (auto/dark/light), favorites pinned mode, Startup AI Speed Scan, shell-env export, per-provider **Test key** button all persisted to the same `~/.free-coding-models.json` the TUI uses |
360
+
361
+ **Keyboard:** `Esc` closes any modal · `Cmd+K` toggles the palette. Everything else is mouse-first.
211
362
 
212
- Provider API keys (all optional):
363
+ **URL deep-linking:** `?tier=S+&sort=verdict&origin=groq&toolMode=goose&q=…` hydrates the dashboard on load **and** every filter/sort/view change is reflected back into the URL (debounced). CLI flags become shareable links — favorites are shared with the TUI through the same config file.
364
+
365
+ <p align="center"><video src="website/public/videos/web-url-deep-linking.mp4" alt="URL deep-linking — filter the dashboard, share the URL" autoplay muted loop playsinline width="100%"></video></p>
366
+
367
+ ### Run it in Docker
368
+
369
+ Run FCM without installing Node.js using the official image:
370
+
371
+ > **Note:** GHCR requires authentication even for public images. Login once with:
372
+ > ```bash
373
+ > echo $GITHUB_TOKEN | docker login ghcr.io -u YOUR_GITHUB_USERNAME --password-stdin
374
+ > ```
375
+ > Or use a [personal access token](https://github.com/settings/tokens) with `read:packages` scope.
213
376
 
214
377
  ```bash
215
- docker run -p 19280:19280 \
216
- -e NVIDIA_API_KEY=your_key \
217
- -e GROQ_API_KEY=your_key \
218
- -e OPENROUTER_API_KEY=your_key \
219
- ghcr.io/vava-nessa/free-coding-models:latest
378
+ # Quick start — daemon + web UI on port 19280
379
+ docker run -p 19280:19280 ghcr.io/vava-nessa/free-coding-models:latest
380
+
381
+ # With an API key
382
+ docker run -p 19280:19280 -e OPENROUTER_API_KEY=your_key ghcr.io/vava-nessa/free-coding-models:latest
220
383
  ```
221
384
 
222
- ### Docker Compose
385
+ Point your coding tool at `http://localhost:19280/v1` with model `fcm` and key `fcm-local`. See the [Smart Model Router](#-the-smart-model-router) section for routing details.
386
+
387
+ **Available image tags:** `latest` · `v{major}.{minor}.{patch}` (e.g. `v0.3.70`) · `v{major}.{minor}` (e.g. `v0.3`) · `v{major}` (e.g. `v0`)
388
+
389
+ | Env var | Default | Description |
390
+ |---------|---------|-------------|
391
+ | `FCM_HOST` | `0.0.0.0` | Bind host (`127.0.0.1` for localhost-only) |
392
+ | `FCM_PORT` | `19280` | Port to listen on |
393
+ | `FREE_CODING_MODELS_TELEMETRY` | `0` | `0` disables telemetry |
223
394
 
224
- Create a `docker-compose.yml`:
395
+ <details>
396
+ <summary><strong>Docker Compose + troubleshooting</strong></summary>
225
397
 
226
398
  ```yaml
227
399
  version: '3.8'
@@ -242,83 +414,112 @@ volumes:
242
414
  fcm-data:
243
415
  ```
244
416
 
245
- Run with `docker-compose up -d`. API keys can be passed via a `.env` file or environment variables.
417
+ **Troubleshooting:**
418
+ - **Won't start** — `docker logs fcm`, and check port 19280 isn't in use (`docker ps | grep 19280`).
419
+ - **Health check fails** — wait ~30s for the first probe cycle; verify keys with `docker exec fcm curl http://localhost:19280/health`.
420
+ - **Can't connect from host** — ensure `FCM_HOST=0.0.0.0` (default) and the firewall allows localhost.
421
+ - **Reset data** — config lives in the `fcm-data` volume; wipe it with `docker-compose down -v`.
246
422
 
247
- ### Troubleshooting
423
+ </details>
248
424
 
249
- **Container won't start:**
250
- - Check logs: `docker logs fcm`
251
- - Verify port 19280 is not in use: `docker ps | grep 19280`
425
+ ---
252
426
 
253
- **Health check fails:**
254
- - Wait 30s for initial probe cycle
255
- - Verify API keys are valid: `docker exec fcm curl http://localhost:19280/health`
427
+ ## 🔌 Agent Extensions
256
428
 
257
- **Cannot connect from host:**
258
- - Ensure `FCM_HOST=0.0.0.0` (default)
259
- - Check firewall allows localhost connections
429
+ FCM ships two **agent extensions** that bring the scanner/ranker directly into your coding agent — so you can hot-swap models mid-session without leaving the terminal. Both share one core (`fcm-agent-core`), so a scan done in one benefits the other.
260
430
 
261
- **Data persistence:**
262
- - Config is stored in Docker volume `fcm-data`
263
- - Recreate the volume with `docker-compose down -v` to reset
431
+ ### OpenCode Plugin — `fcm-opencode` ⚠️ BETA
264
432
 
265
- ---
433
+ The OpenCode adapter for the FCM scanner. Startup is intentionally light: fresh cache first, daemon second, **no direct scan** unless you run `/fcm`.
266
434
 
267
- Need to fix contrast because your terminal theme is fighting the TUI? Press **`G`** at any time to cycle **Auto → Dark → Light**. The switch recolors the full interface live: table, Settings, Help, Smart Recommend, Feedback, and Changelog.
435
+ ```bash
436
+ # Local install (symlink the adapter into OpenCode's plugins dir)
437
+ mkdir -p ~/.config/opencode/plugins
438
+ ln -sf /Users/<you>/Documents/GitHub/free-coding-models/packages/fcm-opencode/index.js \
439
+ ~/.config/opencode/plugins/fcm-opencode.js
440
+ ```
268
441
 
269
- **② Pick a model and launch your tool:**
442
+ > (`opencode-plugin/` at the repo root is kept as a thin compat wrapper, so existing symlinks keep working.)
270
443
 
271
- ```
272
- ↑↓ navigate → Enter to launch
273
- ```
444
+ | Command | Description |
445
+ |---------|-------------|
446
+ | `/fcm` | Run an explicit scan and list ranked choices (no switch) |
447
+ | `/fcm 1` | Switch OpenCode config to ranked model #1 |
448
+ | `/fcm best` | Switch OpenCode config to the best ranked model |
449
+ | `/fcm rescan` | Force a fresh scan |
450
+ | `/fcm status` / `/fcm-status` | Show plugin diagnostics |
451
+ | `/fcm router` / `/fcm-router` | Switch OpenCode config to the local FCM Smart Router daemon |
274
452
 
275
- The model you select is automatically written into your tool's config (📦 OpenCode, 🦞 OpenClaw, 💘 Crush, etc.) and the tool opens immediately. Done.
453
+ Full details: [`packages/fcm-opencode/README.md`](./packages/fcm-opencode/README.md)
276
454
 
277
- If the active CLI tool is missing, FCM now catches it before launch, offers a tiny Yes/No install prompt, installs the tool with its official global command, then resumes the same model launch automatically.
455
+ ### Pi Extension `FCM-Pi` ⚠️ BETA
278
456
 
279
- > 💡 You can also run `free-coding-models --goose --tier S` to pre-filter to S-tier models for Goose before the TUI even opens.
457
+ A native [Pi coding agent](https://pi.dev) extension. It stays **silent by default** no scan, no footer noise, no automatic model switch on boot or `/resume`. It only acts when you ask.
280
458
 
281
- <p align="center">
282
- <img src="demo2.gif" alt="free-coding-models TUI demo" width="100%">
283
- </p>
459
+ **Install** — add the extension path to `~/.pi/agent/settings.json` (not yet on npm — local path only):
284
460
 
285
- ## 🚀 Usage
461
+ ```json
462
+ {
463
+ "packages": [
464
+ "/Users/<you>/Documents/GitHub/free-coding-models/pi-extension"
465
+ ]
466
+ }
467
+ ```
286
468
 
287
- ### Common scenarios
469
+ Then restart Pi. The extension loads automatically. Requires Pi + `free-coding-models` installed and configured with at least one API key.
288
470
 
289
- ```bash
290
- # "I want the local web dashboard"
291
- free-coding-models --daemon
471
+ | Feature | What it does |
472
+ |---------|--------------|
473
+ | **Silent startup** | No scan, no footer noise, no auto-switch on boot or `/resume` |
474
+ | **Manual scan** | `/fcm` pings ~30 candidates in parallel, then waits for your explicit pick |
475
+ | **Live progress** | The Pi status bar shows `⠸ Probing: Kimi K2.6 [Nvidia]…` only while probing, then hides |
476
+ | **10-min disk cache** | Results cached to `~/.pi/agent/fcm-cache.json` for fast diagnostics |
477
+ | **Error-triggered picker** | If a request fails (HTTP 4xx/5xx), FCM reopens the picker and marks the failed model `🔴 BUGGED` |
478
+ | **Daemon integration** | If the router daemon is running (`--daemon-bg`), scan results are fetched instantly from its cache |
292
479
 
293
- # "I want one local endpoint that fails over between free models"
294
- free-coding-models --daemon-bg
295
- free-coding-models --daemon-status
480
+ | Command | Description |
481
+ |---------|-------------|
482
+ | `/fcm` | Re-scan and pick a model interactively from the top 10 |
483
+ | `/fcm-list` | Ranked table of top 20 models (SWE / Latency / TPS / Provider) |
484
+ | `/fcm-router` | Connect Pi to the local FCM Smart Router daemon |
485
+ | `/fcm-status` | Diagnostics: active model, last scan source, daemon state |
296
486
 
297
- # "Start with an elite-focused preset, then adjust filters live"
298
- free-coding-models --premium
487
+ **Composite ranking** SWE-bench (60%) + Latency (20%) + TPS (10%) + Stability (10%). Tiny-context Cerebras models (~8k total tokens) are hidden from Pi/OpenCode pickers since they pass a `hi` probe but fail real agent prompts.
299
488
 
300
- # "I want to script this — give me JSON"
301
- free-coding-models --tier S --json | jq -r '.[0].modelId'
489
+ Full architecture: [`packages/fcm-pi/README.md`](./packages/fcm-pi/README.md)
302
490
 
303
- # "I want to configure OpenClaw with Groq's fastest model"
304
- free-coding-models --openclaw --origin groq
491
+ ### Shared agent architecture
492
+
493
+ ```
494
+ packages/
495
+ ├── fcm-agent-core/ ← shared core (scan, rank, cache, daemon, keys, providers; no rendering)
496
+ ├── fcm-pi/ ← Pi adapter (hooks, commands, status-bar renderer, ~/.pi/agent disk writer)
497
+ └── fcm-opencode/ ← OpenCode adapter (config mutation, commands, toasts, shell.env)
305
498
  ```
306
499
 
307
- When launching the daemon (with `--daemon`), the web dashboard and router API are served from the same port. Configure tools with:
500
+ - The core emits **structured progress events**; each adapter renders them its own way (Pi status bar, OpenCode toast).
501
+ - API keys are never inlined into OpenCode config — referenced via `{env:FCM_<PROVIDER>_API_KEY}`.
502
+ - A **cross-tool cache** means a scan done in Pi benefits OpenCode (and vice-versa).
308
503
 
309
- | Field | Value |
310
- |-------|-------|
311
- | Router Base URL | `http://localhost:19280/v1` |
312
- | Dashboard URL | `http://localhost:19280/` |
313
- | Model | `fcm` |
314
- | API key | `fcm-local` |
504
+ > One-time self-link so `free-coding-models` resolves by name during local-path use:
505
+ > ```bash
506
+ > cd packages && mkdir -p node_modules && ln -s ../../ node_modules/free-coding-models
507
+ > ```
508
+
509
+ Public API & rationale: [`packages/fcm-agent-core/README.md`](./packages/fcm-agent-core/README.md)
510
+
511
+ ---
512
+
513
+ ## 🔀 The Smart Model Router
514
+
515
+ The **FCM Router** is a local OpenAI-compatible daemon. Point any coding tool at a single localhost endpoint and let FCM route each request to the best available model in your active set — with automatic failover when a model 429s or 5xxs.
315
516
 
316
- ### Smart Model Router
517
+ > This is the most advanced surface. Most users start with the TUI or Web Dashboard and only reach for the router once they want *one endpoint that never goes down*.
317
518
 
318
- The **FCM Router** is a local OpenAI-compatible daemon that keeps running after the TUI closes. Point your coding tool at one localhost endpoint and let FCM route each request to the best available model in your active set.
519
+ ### Quick start
319
520
 
320
521
  ```bash
321
- # Start the router in the background
522
+ # Start the router in the background (keeps running after the TUI closes)
322
523
  free-coding-models --daemon-bg
323
524
 
324
525
  # Check the active port, set, model count, uptime, and request totals
@@ -326,13 +527,9 @@ free-coding-models --daemon-status
326
527
 
327
528
  # Stop it cleanly
328
529
  free-coding-models --daemon-stop
329
-
330
- # Auto-discover and live-probe models into a named set
331
- free-coding-models --sync-set
332
- free-coding-models --sync-set my-coding-set
333
530
  ```
334
531
 
335
- Configure tools with:
532
+ Point your coding tool at:
336
533
 
337
534
  | Field | Value |
338
535
  |-------|-------|
@@ -340,30 +537,46 @@ Configure tools with:
340
537
  | Model | `fcm` |
341
538
  | API key | `fcm-local` |
342
539
 
343
- The daemon auto-creates a `fast-coding` set from your configured providers on first start. It stores router settings in `~/.free-coding-models.json`, writes lifecycle logs to `~/.free-coding-models-daemon.log`, and tracks token metadata in `~/.free-coding-models-tokens.json`.
540
+ On first start the daemon auto-creates a `fast-coding` set from your configured providers. It stores router settings in `~/.free-coding-models.json`, writes lifecycle logs to `~/.free-coding-models-daemon.log`, and tracks token metadata in `~/.free-coding-models-tokens.json`.
541
+
542
+ ### How it works
543
+
544
+ **1. Probe mechanism (adaptive cadence)** — the daemon sends a 1-token chat-completion ping to every model in the active set. It measures latency **+ status code**, not just reachability, so a wrong API key is caught and the circuit breaker opens. Probe modes:
545
+
546
+ | Mode | Interval | Use when |
547
+ |------|----------|----------|
548
+ | `eco` | 120s | You want to save quota |
549
+ | `balanced` *(default)* | 30s | Everyday use |
550
+ | `aggressive` | 10s | You're actively debugging routing |
551
+
552
+ **2. Circuit breaker (per-model state)** — each model flips between states:
553
+
554
+ | State | Meaning |
555
+ |-------|---------|
556
+ | 🟢 **Healthy** | Last probe returned 2xx — route here freely |
557
+ | 🔴 **Down** | Last 3 probes failed — skip until cooldown |
558
+ | 🟡 **Recovering** | Cooldown expired — retrying with 1 request |
559
+ | 🟠 **Auth error** | 401/403 — your API key is wrong for this model |
560
+ | ⚪ **Deprecated** | Removed from the catalog — will be replaced |
561
+
562
+ **3. Failover order** — models are tried in priority order; a `Recovering` / `Down` / `Auth error` model is skipped and the request goes to the next healthy one. If *all* fail, you get a `503` with a `models_tried` list in the body for debugging.
563
+
564
+ **4. Auto-heal (on by default)** — at daemon start, any model in `Auth error` or `Deprecated` is swapped for a working alternative (same provider first, then cross-provider). The first time you manually add/remove/reorder a model, auto-heal switches off and your choices are preserved — so a new user with a half-broken key set lands on a usable default set by the time the dashboard renders.
344
565
 
345
566
  ### Playground — chat with the router
346
567
 
347
- Every chat that goes through the FCM router starts with a configurable **pre-prompt** that introduces the assistant as the free-coding-models routing agent. The Playground is the fastest way to try the router without configuring a coding tool.
568
+ The fastest way to try the router without configuring a tool. Every chat starts with a configurable **pre-prompt** that introduces the assistant as the FCM routing agent.
348
569
 
349
570
  ```bash
350
- # 1. Start the router (if it isn't already)
351
- free-coding-models --daemon-bg
352
-
353
- # 2. Open the Playground in the TUI
354
- free-coding-models --playground
355
- # ... or just press ; inside the TUI
356
- # ... or click "Playground" in the web dashboard header
571
+ free-coding-models --daemon-bg # 1. start the router (if not running)
572
+ free-coding-models --playground # 2. open the Playground in the TUI
573
+ # …or press ; inside the TUI
574
+ # …or click "Playground" in the Web Dashboard header
357
575
  ```
358
576
 
359
- The Playground:
360
-
361
- - Streams responses token-by-token (SSE).
362
- - Shows the routed-via provider/model + latency + tokens on every reply.
363
- - Lets you pin a specific model (`fcm` = auto-router, or `groq/<id>` / `cerebras/<id>` / etc.) for manual A/B testing.
364
- - Lets you toggle the pre-prompt per session, so you can see what the model answers *with* and *without* the FCM persona.
577
+ <p align="center"><video src="website/public/videos/router-playground.mp4" alt="Playground — chat with the router and see the routed provider/model" autoplay muted loop playsinline width="100%"></video></p>
365
578
 
366
- The pre-prompt lives in the router config under `router.prePrompt` and can be edited from any surface (the daemon reloads it on its 10s config-refresh tick):
579
+ The Playground streams responses token-by-token (SSE), shows the routed-via provider/model + latency + tokens on every reply, lets you pin a specific model (`fcm` = auto, or `groq/<id>` / `cerebras/<id>` / …) for A/B testing, and lets you toggle the pre-prompt per session. The pre-prompt lives in `router.prePrompt` and is editable from any surface (the daemon reloads it on its 10s config-refresh tick):
367
580
 
368
581
  ```json
369
582
  {
@@ -376,72 +589,113 @@ The pre-prompt lives in the router config under `router.prePrompt` and can be ed
376
589
  }
377
590
  ```
378
591
 
379
- Router endpoints:
592
+ ### Routing behavior details
593
+
594
+ - Priority order works immediately on cold start, then probes refine health over time.
595
+ - **Transient failures** (`429`, `500`, `502`, `503`, timeouts) fail over to the next model.
596
+ - **Auth problems** (`401`, `403`, missing keys) are marked separately so bad credentials never poison the circuit breaker; after one provider returns an auth error, the router skips the rest of that provider for the current request.
597
+ - Upstream HTML maintenance pages and malformed "successful" JSON are treated as retryable provider failures instead of being forwarded to your tool.
598
+ - Quota/rate-limit failures include retry headers in the final router `503` payload when providers expose them.
599
+ - If a coding tool disconnects mid-request, the daemon aborts the upstream request **without** counting it as a provider failure.
600
+ - Streaming requests retry before the first byte; after partial output starts, the daemon records the failure and lets the current stream finish as safely as possible.
601
+
602
+ ### Auto-discover the best set — `--sync-set`
603
+
604
+ `--sync-set [name]` auto-discovers, live-probes, and populates a named router set with the best currently-available coding models — perfect for scheduled refreshes so your set stays current without manual picking.
605
+
606
+ ```bash
607
+ free-coding-models --sync-set # create/refresh the default "auto" set
608
+ free-coding-models --sync-set my-coding-set # named set
609
+ free-coding-models --daemon-bg # then run the daemon with it
610
+ ```
611
+
612
+ Each candidate is probed twice (plain text must return exactly `OK`, and a tool-call must produce a valid `tool_calls` array), so models that work reliably with function-calling tools get in. Run it on a cron to keep the set fresh:
613
+
614
+ ```bash
615
+ # crontab — refresh every 4 hours
616
+ 0 */4 * * * /usr/local/bin/free-coding-models --sync-set >> ~/.free-coding-models-sync.log 2>&1
617
+ ```
618
+
619
+ → Full pipeline, output shape, and failure modes: [`docs/sync-set.md`](./docs/sync-set.md)
620
+
621
+ ### REST API
622
+
623
+ **Router endpoints** (`/v1/...`):
380
624
 
381
625
  | Endpoint | Purpose |
382
626
  |----------|---------|
383
627
  | `POST /v1/chat/completions` | Route through the active set |
384
628
  | `POST /v1/sets/:name/chat/completions` | Route through a named set |
385
- | `GET /v1/models` | Return virtual models (`fcm`, `fcm:set-name`) |
629
+ | `GET /v1/models` | Virtual models (`fcm`, `fcm:set-name`) |
386
630
  | `GET /health` | Daemon status JSON |
387
- | `GET /stats` | Routing, health, request log, and token stats |
631
+ | `GET /stats` | Routing, health, request log, token + probe-cache + quota + runtime stats |
388
632
  | `GET /stream/events` | Live SSE events for router updates |
389
- | `POST /daemon/probe-mode` | Set probe mode with `{ "probeMode": "eco" | "balanced" | "aggressive" }` |
633
+ | `POST /daemon/probe-mode` | Set probe mode `{ "probeMode": "eco" \| "balanced" \| "aggressive" }` |
390
634
 
391
- **Web Dashboard endpoints** (served from the same port in `--daemon` mode):
635
+ **Web Dashboard endpoints** (same port in `--daemon` mode):
392
636
 
393
637
  | Endpoint | Purpose |
394
638
  |----------|---------|
395
639
  | `GET /` | Web dashboard HTML |
396
640
  | `GET /api/models` | All model data with latency stats |
397
641
  | `GET /api/config` | Provider config (keys masked) |
398
- | `GET /api/events` | Live SSE events for dashboard |
399
- | `GET /api/key/:provider` | Reveal full API key for provider |
642
+ | `GET /api/events` | Live SSE events for the dashboard |
643
+ | `GET /api/key/:provider` | Reveal the full API key for a provider |
400
644
  | `POST /api/settings` | Save API keys and provider toggles |
401
645
 
402
- Routing behavior:
403
-
404
- - Priority order works immediately on cold start, then probes refine health scores over time.
405
- - Transient failures (`429`, `500`, `502`, `503`, timeouts) fail over to the next model.
406
- - Authentication problems (`401`, `403`, missing keys) are marked separately so bad credentials do not poison the circuit breaker; after one provider returns an auth error, the router skips the rest of that provider for the current request.
407
- - Upstream HTML maintenance pages and malformed successful JSON are treated as retryable provider failures instead of being forwarded to your coding tool.
408
- - Quota and rate-limit failures include retry headers in the final router `503` payload when providers expose them.
409
- - If a coding tool disconnects mid-request, the daemon aborts the upstream request without counting it as a provider failure.
410
- - Streaming requests retry before the first byte; after partial output starts, the daemon records the failure and lets the current stream finish as safely as possible.
411
-
412
- ### Tool launcher flags
646
+ Full router guide: [`docs/README_ROUTER.md`](./docs/README_ROUTER.md)
413
647
 
414
- | Flag | Launches |
415
- |------|----------|
416
- | `--opencode` | 📦 OpenCode CLI |
417
- | `--opencode-desktop` | 📦 OpenCode Desktop |
418
- | `--opencode-web` | 📦 OpenCode WebUI |
419
- | `--openclaw` | 🦞 OpenClaw |
420
- | `--crush` | 💘 Crush |
421
- | `--goose` | 🪿 Goose |
422
- | `--aider` | 🛠 Aider |
423
- | `--kilo` | ⚡️ Kilo CLI |
424
- | `--qwen` | 🐉 Qwen Code |
425
- | `--openhands` | 🤲 OpenHands |
426
- | `--amp` | ⚡ Amp |
427
- | `--hermes` | 🔮 Hermes |
428
- | `--continue` | ▶️ Continue CLI |
429
- | `--cline` | 🧠 Cline |
430
- | `--xcode` | 🛠️ Xcode Intelligence |
431
- | `--pi` | π Pi |
432
- | `--copilot` | 🤖 Copilot CLI |
433
- | `--forgecode` | 🔥 ForgeCode |
434
- | `--zcode` | 🧊 ZCode |
648
+ ---
435
649
 
436
- Press **`Z`** in the TUI to cycle between tools without restarting.
650
+ ## 📖 Reference
437
651
 
438
- ### CLI-Only Tools
652
+ The internals below power every surface. They're gathered here so they don't interrupt the core workflow above.
439
653
 
440
- **Note:** When launching these tools via `Z` key or command palette, if the current mode doesn't match the tool, you'll see a confirmation alert asking to switch to the correct tool before launching.
654
+ ### CLI flags
441
655
 
442
- ### OpenCode Zen Free Models
656
+ Flags combine freely in any order. Run `free-coding-models --help` to print the full list in-app.
443
657
 
444
- [OpenCode Zen](https://opencode.ai/zen) is a hosted AI gateway offering **5 free coding models** exclusively through OpenCode CLI and OpenCode Desktop. These models are **not** available through other tools.
658
+ | Flag | Effect |
659
+ |------|--------|
660
+ | `--best` | Show only top tiers (A+, S, S+) |
661
+ | `--premium` | Start with an S-tier filter + verdict sort (resettable in-app) |
662
+ | `--tier <S\|A\|B\|C>` | Filter by tier family (`S` = S+/S, `A` = A+/A/A-, …) |
663
+ | `--origin <provider>` | Filter by provider (e.g. `nvidia`, `groq`, `cerebras`) |
664
+ | `--sort <column>` | Sort by `rank, tier, origin, model, ping, avg, swe, ctx, condition, verdict, uptime, stability, aiLatency, tps` |
665
+ | `--asc` / `--desc` | Sort direction |
666
+ | `--json` | Skip the TUI — print all results as JSON and exit (great for `jq`) |
667
+ | `--fiable` | Wait 10s, pick the most reliable model, print `provider/model_id` and exit |
668
+ | `--recommend` | Open Smart Recommend immediately on startup |
669
+ | `--hide-unconfigured` / `--show-unconfigured` | Control whether models without a key are shown |
670
+ | `--ping-interval <ms>` | Override the ping interval |
671
+ | `--reprobe` / `--no-cache` | Rebuild the persistent probe-cache this run |
672
+ | `--probe-ttl <ms>` | Override the probe-cache TTL (default 24h) |
673
+ | `--show-broken` | Don't auto-hide broken models this run |
674
+ | `--check-drift` | Diff `sources.js` against `models.dev`; exit 1 on mismatch |
675
+ | `--no-telemetry` | Disable anonymous telemetry for this run |
676
+
677
+ **Tool launchers** — start the TUI pre-configured for a tool, then `Enter` writes the model into that tool's config and launches it:
678
+
679
+ | Flag | Tool | Flag | Tool |
680
+ |------|------|------|------|
681
+ | `--opencode` | 📦 OpenCode CLI | `--openhands` | 🤲 OpenHands |
682
+ | `--opencode-desktop` | 📦 OpenCode Desktop | `--amp` | ⚡ Amp |
683
+ | `--opencode-web` | 📦 OpenCode WebUI | `--hermes` | 🔮 Hermes |
684
+ | `--openclaw` | 🦞 OpenClaw | `--continue` | ▶️ Continue CLI |
685
+ | `--crush` | 💘 Crush | `--cline` | 🧠 Cline |
686
+ | `--goose` | 🪿 Goose | `--xcode` | 🛠️ Xcode Intelligence |
687
+ | `--aider` | 🛠 Aider | `--pi` | π Pi |
688
+ | `--kilo` | ⚡️ Kilo CLI | `--copilot` | 🤖 Copilot CLI |
689
+ | `--qwen` | 🐉 Qwen Code | `--forgecode` | 🔥 ForgeCode |
690
+ | | | `--zcode` | 🧊 ZCode |
691
+
692
+ > Default (no tool flag) = OpenCode CLI. Press **`Z`** in the TUI to cycle tools without restarting. Incompatible models get a dark-red row background when a tool mode is active.
693
+
694
+ → Full flag reference: [`docs/flags.md`](./docs/flags.md) · Tool → config mapping: [`docs/integrations.md`](./docs/integrations.md)
695
+
696
+ ### OpenCode Zen — free models exclusive to OpenCode
697
+
698
+ [OpenCode Zen](https://opencode.ai/zen) is a hosted AI gateway offering **5 free coding models** exclusively through OpenCode CLI/Desktop (OpenAI-compatible endpoint, so other tools can use them too):
445
699
 
446
700
  | Model | Tier | SWE-bench | Context |
447
701
  |-------|------|-----------|---------|
@@ -451,351 +705,82 @@ Press **`Z`** in the TUI to cycle between tools without restarting.
451
705
  | Nemotron 3 Super Free | A+ | 52.0% | 200k |
452
706
  | MiniMax M3 Free | S+ | 59.0% | 1M |
453
707
 
454
- To use Zen models: sign up at [opencode.ai/auth](https://opencode.ai/auth) and enter your Zen API key via `P` (Settings). Zen models appear in the main table and auto-switch to OpenCode CLI on launch.
455
-
456
- ### Tool Compatibility
457
-
458
- When a tool mode is active (via `Z`), models incompatible with that tool are highlighted with a dark red background so you can instantly see which models work with your current tool.
459
-
460
- | Model Type | Compatible Tools |
461
- |------------|-----------------|
462
- | Regular (NVIDIA, Groq, etc.) | All tools |
463
- | OpenCode Zen | All tools (OpenAI-compatible endpoint) |
464
-
465
- → **[Full flags reference](./docs/flags.md)**
466
-
467
- ---
468
-
469
- ## 🧠 Persistent probe cache
470
-
471
- Every health probe result is cached to `~/.free-coding-models/probe-cache.json` for **24 hours** and **shared across all surfaces** (CLI TUI, Web Dashboard / daemon, Tauri Desktop).
472
-
473
- - **Warm start** renders the full ranking in <500ms using the cached results, then re-pings only the models that are due (broken or past TTL).
474
- - **Broken models** are auto-hidden across sessions — a model that 401s today stays out of tomorrow's default view. Recovery is automatic: if it comes back `ok`, it un-hides on the next probe.
475
- - **Cross-process safe**: a debounced flush + atomic rename + read-merge-write means the CLI and the daemon can share the file without clobbering each other.
708
+ Sign up at [opencode.ai/auth](https://opencode.ai/auth), enter your Zen key via `P`, and Zen models appear in the main table (auto-switching to OpenCode CLI on launch).
476
709
 
477
- ### Where the cache lives
710
+ ### 🧠 Persistent probe cache
478
711
 
479
- | Env / OS | Path |
480
- |----------|------|
481
- | `XDG_CACHE_HOME` set | `$XDG_CACHE_HOME/free-coding-models/probe-cache.json` |
482
- | Default (macOS / Linux) | `~/.free-coding-models/probe-cache.json` |
483
- | Windows | `%USERPROFILE%\.free-coding-models\probe-cache.json` |
712
+ Every health-probe result is cached to `~/.free-coding-models/probe-cache.json` for **24 hours** and **shared across all surfaces** (CLI TUI, Web Dashboard / daemon, Tauri Desktop).
484
713
 
485
- Inspect or wipe it manually any time it's plain JSON with `0600` perms.
714
+ - **Warm start** renders the full ranking in <500ms using cached results, then re-pings only models that are due (broken or past TTL).
715
+ - **Broken models** are auto-hidden across sessions — a model that 401s today stays out of tomorrow's default view, and recovers automatically when it returns `ok`.
716
+ - **Cross-process safe** — debounced flush + atomic rename + read-merge-write, so the CLI and the daemon share the file without clobbering each other.
486
717
 
487
- ### CLI flags
488
-
489
- | Flag | Effect |
490
- |------|--------|
491
- | `--reprobe` / `--no-cache` | Nuke the cache before this run; ping everything fresh |
718
+ | Flag / key | Effect |
719
+ |------------|--------|
720
+ | `--reprobe` / `--no-cache` | Nuke the cache; ping everything fresh |
492
721
  | `--probe-ttl <ms>` | Override the 24h TTL (e.g. `--probe-ttl 3600000` for 1h) |
493
- | `--show-broken` | Don't auto-hide broken models this run (one-shot override) |
494
-
495
- ### TUI keys
722
+ | `--show-broken` | Don't auto-hide broken models this run |
723
+ | `Shift+B` (TUI) | Toggle broken-model visibility (footer: `⚡ N cached · 🔴 M broken`) |
496
724
 
497
- | Key | Effect |
498
- |-----|--------|
499
- | **Shift+B** | Toggle visibility of broken models (footer chip shows `⚡ N cached · 🔴 M broken`) |
725
+ **Cache location:** `$XDG_CACHE_HOME/free-coding-models/probe-cache.json` if set, else `~/.free-coding-models/probe-cache.json` (Windows: `%USERPROFILE%\.free-coding-models\probe-cache.json`). Plain JSON, `0600` perms — inspect or wipe it any time.
500
726
 
501
- ### Daemon `/stats` shape
502
-
503
- ```json
504
- {
505
- "probeCache": {
506
- "total": 222,
507
- "ok": 178,
508
- "broken": 13,
509
- "freshCount": 165,
510
- "staleCount": 13,
511
- "dueCount": 26,
512
- "hiddenCount": 13,
513
- "providers": 9
514
- }
515
- }
516
- ```
517
-
518
- ---
519
-
520
- ## 📊 Live quota from response headers
727
+ ### 📊 Live quota from response headers
521
728
 
522
729
  Every chat-completion response carries rate-limit headers (`x-ratelimit-remaining-requests`, etc.). The daemon parses them passively on every routed request — **zero extra network requests, zero quota waste**.
523
730
 
524
- - **8 header variants** supported: SambaNova, Mistral, generic `x-ratelimit-*`, the `ratelimit-*` (no-`x-`) variant some proxies use, and 3 daily / token / token-minute variants for Cerebras-style providers.
525
- - **Pre-warmed by pings**: even health-check pings return headers, so quota is visible in the CLI before you ever route a real request through the daemon.
526
- - **5-minute staleness**: snapshots older than 5 minutes are excluded, with the active `/api/v1/key` fetcher as fallback for idle providers.
527
- - **Case-insensitive**: some proxies vary casing; we handle all of them.
528
- - **Garbage-safe**: `limit: 0`, non-numeric values, or missing pairs return `null` (no crash).
529
-
530
- ### Where it shows up
731
+ - **8 header variants** supported (SambaNova, Mistral, generic `x-ratelimit-*`, no-`x-` proxy variant, + 3 daily/token/token-minute Cerebras-style variants).
732
+ - **Pre-warmed by pings** even health pings return headers, so quota is visible before you ever route a real request.
733
+ - **5-minute staleness** snapshots older than 5 min are excluded, with the active `/api/v1/key` fetcher as fallback for idle providers.
531
734
 
532
735
  | Surface | What you'll see |
533
736
  |---------|-----------------|
534
- | TUI footer | `📊 groq 78% · sambanova 41%` chip (top 5 most-depleted first) |
535
- | Web Dashboard | New `Provider Quota` section with animated progress bars per provider |
536
- | `/api/router/stats` | `quota: { providerKey: { remaining, limit, percent, source, lastUpdated, windowType } }` |
537
-
538
- ### Daemon `/stats.quota` shape
737
+ | TUI footer | `📊 groq 78% · sambanova 41%` (top 5 most-depleted first) |
738
+ | Web Dashboard | `Provider Quota` section with animated progress bars |
739
+ | `/stats.quota` | `{ providerKey: { remaining, limit, percent, source, lastUpdated, windowType } }` |
539
740
 
540
- ```json
541
- {
542
- "quota": {
543
- "groq": { "remaining": 14, "limit": 30, "percent": 47, "windowType": "requests", "source": "header", "lastUpdated": 1753478400000 },
544
- "sambanova": { "remaining": 1500, "limit": 14400, "percent": 10, "windowType": "day", "source": "header", "lastUpdated": 1753478400000 }
545
- }
546
- }
547
- ```
741
+ The `source` field is `"header"` (passive) or `"endpoint"` (active fetcher) — handy in devtools to debug why a provider shows the value it does.
548
742
 
549
- The `source` field is `"header"` when the value came from a passive response header, `"endpoint"` when it came from the active `/api/v1/key` fetcher. Use it in devtools to debug why a provider shows the value it does.
743
+ ### 📈 Runtime telemetry: real-world scores
550
744
 
551
- ---
745
+ Every routed request through the daemon feeds a persistent per-model telemetry file (`~/.free-coding-models/runtime-telemetry.json`) — the **honesty layer** that complements SWE-bench with what models *actually* do on free tiers.
552
746
 
553
- ## 📈 Runtime telemetry: real-world scores
554
-
555
- Every routed request through the daemon feeds a persistent per-model telemetry file (`~/.free-coding-models/runtime-telemetry.json`) — the **honesty layer** that complements SWE-bench with what models actually do on free tiers.
556
-
557
- - **Real success rate** — `(successCalls / totalCalls)` updated on every routed request (success and failure paths alike).
558
- - **Real throughput** — `avgTokensPerSecond` derived from completion tokens / total latency, so you see what your code actually streams at.
559
- - **Recent calls (last 50)** — for debugging "why did this just 500?" without rebuilding state.
560
- - **Composite `Real` score** — `successRate × 0.6 + sigmoid01(tok/s) × 0.25 + recency × 0.15`. Null when below `MIN_CALLS_FOR_SCORE = 5` (no penalty for new models).
561
-
562
- ### Where it shows up
747
+ - **Real success rate** = `successCalls / totalCalls` (updated on every request, success and failure alike).
748
+ - **Real throughput** = `avgTokensPerSecond` from completion tokens / total latency.
749
+ - **Recent calls (last 50)**for "why did this just 500?" without rebuilding state.
750
+ - **Composite `Real` score** = `successRate × 0.6 + sigmoid01(tok/s) × 0.25 + recency × 0.15` (null below 5 calls — no penalty for new models).
563
751
 
564
752
  | Surface | What you'll see |
565
753
  |---------|-----------------|
566
- | TUI `Real` column | Inline composite score per row, `–` when insufficient data |
567
- | TUI `W` sort key | Sort by real-world score descending |
568
- | TUI `Shift+W` | Runtime Report overlay — per-model breakdown + recent calls |
754
+ | TUI `Real` column | Inline composite per row (`–` when insufficient) |
755
+ | TUI `W` / `Shift+W` | Sort by real-world score / Runtime Report overlay |
569
756
  | Web Dashboard | "Runtime Telemetry" cards with animated success-rate bars |
570
- | `/api/router/stats.runtime` | `{ stats: { modelsTracked, totalCalls, modelsWithSignal }, models: { ... } }` |
571
-
572
- ### Privacy
573
-
574
- The telemetry file lives **locally only** (`~/.free-coding-models/runtime-telemetry.json`, `0600` perms). Nothing is sent upstream unless you opt in to a future aggregate leaderboard. The file holds **metadata only** — success, latency, tokens, error reason. No prompts, no responses, no content.
575
-
576
- ### CLI flag
577
-
578
- - `--clear-runtime` — wipe the file before launching (reset the baseline).
579
-
580
- ---
581
-
582
- ## π Pi Extension — FCM-Pi ⚠️ BETA
583
-
584
- **FCM-Pi** is a native [Pi coding agent](https://pi.dev) extension that integrates `free-coding-models` directly into your Pi session. It stays silent by default, scans only when you run `/fcm`, and lets you explicitly hot-swap models mid-session.
757
+ | `/stats.runtime` | `{ stats: { modelsTracked, totalCalls, modelsWithSignal }, models: {} }` |
585
758
 
586
- > **BETA** — The extension is under active development and not yet published to npm. Install via local path only.
587
- >
588
- > **Requires**: Pi coding agent (pi.dev) + free-coding-models installed and configured with at least one API key.
589
-
590
- ### Installation
591
-
592
- Add the extension path to `~/.pi/agent/settings.json` (the extension is **not yet on npm** — local path only for now):
593
-
594
- ```json
595
- {
596
- "packages": [
597
- "/Users/yourname/Documents/GitHub/free-coding-models/pi-extension"
598
- ]
599
- }
600
- ```
601
-
602
- Then restart Pi. The extension loads automatically.
759
+ **Privacy** — the file is **local only** (`0600` perms) and holds metadata only: success, latency, tokens, error reason. No prompts, no responses, no content. Wipe the baseline with `--clear-runtime`.
603
760
 
604
- ### What it does
761
+ ### Features at a glance
605
762
 
606
- | Feature | Description |
607
- |---------|-------------|
608
- | **Silent startup** | No scan, no footer noise, and no automatic model switch on Pi boot or `/resume` |
609
- | **Manual scan** | `/fcm` pings ~30 candidate models in parallel and waits for your explicit selection |
610
- | **Temporary progress scan** | The Pi status bar shows live scan progress only while probing/benchmarking, then hides again |
611
- | **10-minute disk cache** | Results are cached to `~/.pi/agent/fcm-cache.json` for faster diagnostics and lists |
612
- | **Error-triggered picker** | If a request fails (HTTP 4xx/5xx), FCM reopens the picker and marks the failed model `🔴 BUGGED` |
613
- | **Daemon integration** | If the FCM router daemon is running (`free-coding-models --daemon-bg`), scan results are fetched instantly from its cache |
614
-
615
- ### Scan progress display
616
-
617
- During `/fcm`, the Pi footer status shows:
618
-
619
- ```
620
- ⠸ Probing: Kimi K2.6 [Nvidia], Step 3.5 Flash [Stepfun] — 47% (14/30)
621
- ⠼ Benchmarking: GLM 4.7 [Cerebras] — 60% (3/5)
622
- ```
623
-
624
- - **Spinner** — 10-frame Braille animation at 80ms
625
- - **Phase label** — `Probing` (ping phase) or `Benchmarking` (AI latency phase)
626
- - **Live model name + provider** — shows the last 2 models being probed, scrolling as results come in
627
- - **Progress %** and counter always visible
628
-
629
- ### Commands
630
-
631
- | Command | Description |
632
- |---------|-------------|
633
- | `/fcm` | Re-scan and pick a model interactively from the top 10 ranked |
634
- | `/fcm-list` | Display a ranked table of top 20 available models (SWE / Latency / TPS / Provider) |
635
- | `/fcm-router` | Explicitly connect Pi to the local FCM Smart Router daemon |
636
- | `/fcm-status` | Show diagnostics: active model, last scan source, daemon state |
637
-
638
- ### Composite ranking
639
-
640
- Models are ranked using a composite score:
641
-
642
- | Weight | Metric | Description |
643
- |--------|--------|-------------|
644
- | **60%** | SWE-bench score | Coding capability |
645
- | **20%** | Latency | Network round-trip response time |
646
- | **10%** | TPS | Token throughput speed |
647
- | **10%** | Stability | Uptime + success rate |
648
-
649
- ### Context window limits
650
-
651
- Cerebras free-tier API has a strict **~8k total token limit** (prompt + tools + completion). Tiny-context models can pass a `hi` probe but fail real agent prompts, so FCM hides 8k Cerebras models from Pi/OpenCode pickers.
652
-
653
- ### Full documentation
654
-
655
- The adapter lives in [`packages/fcm-pi`](./packages/fcm-pi); `pi-extension/` is kept as a thin compat wrapper so existing local-path installs keep loading. See [`packages/fcm-pi/README.md`](./packages/fcm-pi/README.md) for the complete architecture, config format, and the one-time `packages/` self-link setup.
656
-
657
- ---
658
-
659
- ## OpenCode Plugin — fcm-opencode ⚠️ BETA
660
-
661
- `fcm-opencode` is the OpenCode adapter for the same FCM scanner/ranker used by FCM-Pi.
662
-
663
- ### Local install
664
-
665
- ```bash
666
- mkdir -p ~/.config/opencode/plugins
667
- ln -sf /Users/vava/Documents/GitHub/free-coding-models/packages/fcm-opencode/index.js \
668
- ~/.config/opencode/plugins/fcm-opencode.js
669
- ```
670
-
671
- (`opencode-plugin/` at the repo root is kept as a thin compat wrapper, so existing symlinks keep working.)
672
-
673
- ### Commands
674
-
675
- | Command | Description |
676
- |---------|-------------|
677
- | `/fcm` | Run an explicit scan and list ranked choices without switching |
678
- | `/fcm 1` | Switch OpenCode config to ranked model #1 |
679
- | `/fcm best` | Switch OpenCode config to the best ranked model |
680
- | `/fcm rescan` | Force a fresh scan |
681
- | `/fcm status` or `/fcm-status` | Show plugin diagnostics |
682
- | `/fcm router` or `/fcm-router` | Switch OpenCode config to the local FCM Smart Router daemon |
683
-
684
- Startup is intentionally light: fresh cache first, daemon second, **no direct scan** unless you run `/fcm`.
685
-
686
- See [`packages/fcm-opencode/README.md`](./packages/fcm-opencode/README.md) for details and limitations.
687
-
688
- ---
689
-
690
- ## 🧩 Agent extensions architecture
691
-
692
- Both adapters share one core so scan/rank/cache/daemon/API-key/provider logic lives in exactly one place:
693
-
694
- ```
695
- packages/
696
- ├── fcm-agent-core/ ← shared core (scan, rank, cache, daemon, keys, provider descriptors; no rendering)
697
- ├── fcm-pi/ ← Pi adapter (hooks, commands, status-bar renderer, ~/.pi/agent disk writer)
698
- └── fcm-opencode/ ← OpenCode adapter (config mutation, commands, toasts, shell.env)
699
- ```
700
-
701
- - The core emits **structured progress events**; each adapter renders them its own way (Pi status bar, OpenCode toast).
702
- - API keys are never inlined into OpenCode config — they are referenced via `{env:FCM_<PROVIDER>_API_KEY}`.
703
- - The cross-tool cache means a scan done in Pi benefits OpenCode (and vice-versa).
704
-
705
- > The `packages/` tree needs a one-time self-link so `free-coding-models` resolves by name during local-path use:
706
- > ```bash
707
- > cd packages && mkdir -p node_modules && ln -s ../../ node_modules/free-coding-models
708
- > ```
709
-
710
- See [`packages/fcm-agent-core/README.md`](./packages/fcm-agent-core/README.md) for the public API and rationale. Tracked in [`.kandown/tasks/t2.md`](./.kandown/tasks/t2.md).
711
-
712
- ---
713
-
714
- ## ⌨️ TUI Keys
715
-
716
- ### Keyboard
717
-
718
- | Key | Action |
719
- |-----|--------|
720
- | `↑↓` | Navigate models |
721
- | `Enter` | Launch selected model in active tool |
722
- | `Z` | Cycle target tool |
723
- | `T` | Cycle tier filter |
724
- | `D` | Cycle provider filter |
725
- | `E` | Cycle visibility filter (`Active only → Configured only → Usable only`) |
726
- | `F` | Favorite / unfavorite model |
727
- | `Y` | Toggle favorites mode (`Normal filter/sort` default ↔ `Pinned + always visible`) |
728
- | `X` | Clear active custom text filter |
729
- | `G` | Cycle global theme (`Auto → Dark → Light`) |
730
- | `Ctrl+P` | Open ⚡️ command palette (search + run actions) |
731
- | `;` | Open the Playground chat overlay (chat with the FCM router) |
732
- | `Ctrl+A` | Run AI Speed Test for the selected model |
733
- | `Ctrl+U` | Run Global AI Speed Test (uses real provider requests) |
734
- | `R/S/C/M/O/L/A/H/V/B/U` | Sort columns |
735
- | `Shift+U` | Update to latest version (when update available) |
736
- | `P` | Settings (API keys, providers, updates, theme) |
737
- | `Q` | Smart Recommend overlay |
738
- | `N` | Changelog |
739
- | `W` | Cycle ping cadence |
740
- | `I` | Feedback / bug report |
741
- | `K` | Help overlay |
742
- | `Ctrl+C` | Exit |
743
-
744
- ### Mouse
745
-
746
- | Action | Result |
747
- |--------|--------|
748
- | **Click column header** | Sort by that column |
749
- | **Click Tier header** | Cycle tier filter |
750
- | **Click CLI Tools header** | Cycle tool mode |
751
- | **Click model row** | Move cursor to model |
752
- | **Double-click model row** | Select and launch model |
753
- | **Right-click model row** | Toggle favorite |
754
- | **Scroll wheel** | Navigate table / overlays / palette |
755
- | **Click footer hotkey** | Trigger that action |
756
- | **Click update banner** | Install latest version and relaunch |
757
- | **Click command palette item** | Select item (double-click to confirm) |
758
- | **Click recommend option** | Select option (double-click to confirm) |
759
- | **Click outside modal** | Close command palette |
760
-
761
- → **[Stability score & column reference](./docs/stability.md)**
762
-
763
- ---
764
-
765
- ## ✨ Features
766
-
767
- - **Parallel pings** — all ~222 API/Zen-callable models tested simultaneously via native `fetch`
768
- - **AI benchmark columns** — `Ctrl+A` benchmarks the selected model, `Ctrl+U` benchmarks visible models, and results split cleanly into **AI Latency** plus **TPS**. Settings includes an opt-in **Startup AI Speed Scan** toggle to run the global benchmark automatically after launch.
769
- - **Tiny verdict indicator** — the first `❔` column mirrors the full Verdict as a compact emoji (`🟩`, `🟢`, `🟡`, `🟠`, etc.) and sorts by the same verdict order.
763
+ - **Parallel pings** all ~222 models tested simultaneously via native `fetch`
764
+ - **AI benchmark columns** — `Ctrl+A` / `Ctrl+U` split into AI Latency + TPS; optional Startup AI Speed Scan
770
765
  - **Adaptive monitoring** — 2s burst for 60s → 10s normal → 30s idle
771
- - **Stability score** — composite 0–100 (p95 latency, jitter, spike rate, uptime)
766
+ - **Stability score** — composite 0–100 (p95, jitter, spike rate, uptime)
772
767
  - **Smart ranking** — top 3 highlighted 🥇🥈🥉
773
- - **Favorites** — star models with `F`, persisted across sessions, default to normal rows, and switch display mode with `Y` (pinned+sticky vs normal rows)
774
- - **Configured-only default** — only shows providers you have keys for
775
- - **Keyless latency** — models ping even without an API key (show 🔑 NO KEY)
776
- - **Unusable row fade** — rows in `NO KEY` or `AUTH FAIL` state are rendered at 80% opacity (20% less opaque) on every surface (TUI + Web + Desktop), so the user can scan the table and instantly see which models they cannot actually use. Composes cleanly with the favorite/recommended/incompatible background tints.
768
+ - **Configured-only default** — shows only providers you have keys for; keyless models still ping (🔑 NO KEY)
777
769
  - **Smart Recommend** — questionnaire picks the best model for your task type
778
- - **Smart Model Router** — local OpenAI-compatible daemon with model sets, failover, circuit breakers, health probes, and token stats
779
- - **Playground chat** — multi-turn chat with the router on every surface (TUI `;` / Web Playground nav / `free-coding-models --playground`). Streams responses and shows the routed-via provider/model on every reply.
780
- - **Auto-heal on startup** — the daemon replaces broken models in the active set (`AUTH_ERROR` / `STALE`) with working alternatives from the same provider first, then cross-provider. The first manual edit disables auto-heal so user choices are preserved. A new user with a half-broken key set lands on a usable default set by the time the dashboard renders.
781
- - **Web router set manager** — add, remove, drag-and-drop, and probe-sync the active router set from inside the Web Dashboard. The "Sync best models" button re-pings every candidate with the user's actual API keys and rebuilds the set with only models that return 2xx, so a new user lands on a working default set instead of a hardcoded one that 401s.
782
- - **Router pre-prompt** — a configurable first-class system message injected by the daemon on every `/v1/chat/completions` request it proxies. Default persona introduces the assistant as the FCM routing agent; editable from any surface.
783
- - **⚡️ Command Palette** — `Ctrl+P` opens a searchable action launcher for filters, sorting, overlays, and quick toggles
784
- - **Install Endpoints** — push a full provider catalog into any tool's config (from Settings `P` or ⚡️ Command Palette)
785
- - **Missing tool bootstrap** — detect absent CLIs, offer one-click install, then continue the selected launch automatically
786
- - **Tool compatibility matrix** — incompatible rows highlighted in dark red when a tool mode is active
787
- - **OpenCode Zen models** — 8 free models exclusive to OpenCode CLI/Desktop, powered by the Zen AI gateway
788
- - **Width guardrail** — shows a warning instead of a broken table in narrow terminals
789
- - **Readable everywhere** — semantic theme palette keeps table rows, overlays, badges, and help screens legible in dark and light terminals
790
- - **Global theme switch** — `G` cycles `auto`, `dark`, + `light` live without restarting
791
- - **Auto-retry** timeout models keep getting retried
792
- - **Mandatory self-update policy** — startup checks npm for a newer FCM and installs it automatically without a prompt. If the install fails twice in a row (offline, proxy, or permissions), FCM still starts but shows a red outdated-version warning until the user retries with `Shift+U` or runs the displayed install command.
793
- - **Last release timestamp** — light pink footer shows `Last release: Mar 27, 2026, 09:42 PM` from npm so users know how fresh the data is
794
- - **Persistent probe-cache (t1)** — every health probe result is cached to `~/.free-coding-models/probe-cache.json` for 24h. Warm starts render the full ranking in <500ms, only re-ping the models that are due (broken or TTL-expired). Broken models are auto-hidden across sessions — toggle visibility with **Shift+B**. See [Persistent probe cache](#-persistent-probe-cache) below for `--reprobe`, `--probe-ttl`, `--show-broken`.
795
- - **Live quota from response headers (t2)** — every routed chat-completion response already carries `x-ratelimit-*` headers. The daemon parses them in 8 variants and exposes live per-provider quota on the TUI footer (`📊 groq 78% · sambanova 41%`) and in the Web Dashboard (`Provider Quota` section with animated progress bars). Zero extra network requests, zero quota waste. See [Live quota from headers](#-live-quota-from-response-headers) below.
796
- - **Runtime telemetry: real-world scores (t3)** — every routed request through the daemon feeds a persistent per-model telemetry file (`~/.free-coding-models/runtime-telemetry.json`) with real success rate, throughput, and recent calls. The `Real` column + `W` sort key in the TUI rank models by what *actually* works on free tiers, not what they claim on SWE-bench. See [Runtime telemetry](#-runtime-telemetry-real-world-scores) below.
797
- - **Extended benchmark catalog (t4)** — `src/data/benchmarks.json` (49 well-known models committed, refreshed at every release via `pnpm update:benchmarks`) layers **Coding Index, Math Index, Agentic Index, Reasoning Index, MMLU-Pro, GPQA, HLE** on top of `sources.js` with a lazy `Proxy` load + prefix-indexed O(key length) lookup. Surfaced on the TUI footer as `📊 bench 49 (2026-07-25)`. Curated SWE-bench scores are never overwritten — the overlay is additive.
798
- - **Live `models.dev` enrichment + drift detection (t5)** — the community-maintained `models.dev` catalog is fetched in the background (5 min in-process cache, 3 retries × 250 ms backoff) and overlaid onto every merged model with `metaSource` provenance. The footer chip shows `📡 102 live · 62 curated` so you see at a glance which values came from upstream. `--check-drift` prints a human-readable drift report vs `sources.js`; a weekly CI job opens a `catalog-drift` issue if anything changed.
770
+ - **Smart Model Router** — local OpenAI-compatible daemon with model sets, failover, circuit breakers, health probes, token stats
771
+ - **Playground chat** — multi-turn chat with the router on every surface
772
+ - **⚡️ Command Palette** — `Ctrl+P` fuzzy action launcher
773
+ - **Install Endpoints** — push a full provider catalog into any tool's config
774
+ - **Missing-tool bootstrap** — detect absent CLIs, offer one-click install, resume the launch
775
+ - **Tool compatibility matrix** — incompatible rows highlighted in dark red
776
+ - **Width guardrail** — warning instead of a broken table in narrow terminals
777
+ - **Mandatory self-update** — checks npm on startup and auto-installs; falls back to a red warning if install fails twice
778
+ - **Extended benchmark catalog** — `src/data/benchmarks.json` layers Coding/Math/Agentic/Reasoning/MMLU-Pro/GPQA/HLE on top of `sources.js` (footer: `📊 bench 49 (2026-07-25)`)
779
+ - **Live `models.dev` enrichment + drift detection** — community catalog overlaid in the background (footer: `📡 102 live · 62 curated`); `--check-drift` prints a drift report
780
+
781
+ ### Configuration file
782
+
783
+ `~/.free-coding-models.json` (created on first run, `0600` perms) holds API keys, provider toggles, favorites, settings, and the router config. The TUI reads env vars first; the daemon reads config first then falls back to env vars (background services may not inherit your shell). → [`docs/config.md`](./docs/config.md)
799
784
 
800
785
  ---
801
786
 
@@ -803,25 +788,19 @@ See [`packages/fcm-agent-core/README.md`](./packages/fcm-agent-core/README.md) f
803
788
 
804
789
  We welcome contributions — issues, PRs, new provider integrations.
805
790
 
806
- **Q:** How accurate are the latency numbers?
807
- **A:** Real round-trip times measured by your machine. Results depend on your network and provider load at that moment.
791
+ **Q: How accurate are the latency numbers?**
792
+ A: Real round-trip times measured by your machine. Results depend on your network and provider load at that moment.
808
793
 
809
- **Q:** Can I add a new provider?
810
- **A:** Yes — see [`sources.js`](./sources.js) for the model catalog format.
794
+ **Q: Can I add a new provider?**
795
+ A: Yes — see [`sources.js`](./sources.js) for the model catalog format.
811
796
 
812
- **[Development guide](./docs/development.md)** · **[Config reference](./docs/config.md)** · **[Tool integrations](./docs/integrations.md)**
797
+ → [Development guide](./docs/development.md) · [Config reference](./docs/config.md) · [Tool integrations](./docs/integrations.md) · [Stability & columns](./docs/stability.md) · [Sync-set](./docs/sync-set.md)
813
798
 
814
799
  ---
815
800
 
816
801
  ## ⚖️ Model Licensing & Commercial Use
817
802
 
818
- **Short answer:** The ~170 cataloged models are API/CLI-served models where generated-output ownership is generally granted by the provider/model terms. Always verify current provider terms for high-stakes commercial use.
819
-
820
- ### Output Ownership
821
-
822
- For every model in this tool, **you own the generated output** — code, text, or otherwise — and can use it commercially. The licenses below govern the *model weights themselves*, not your generated content.
823
-
824
- ### License Breakdown by Model Family
803
+ **Short answer:** the ~222 cataloged models are API/CLI-served models where generated-output ownership is generally granted by the provider/model terms. **You own the generated output** code, text, or otherwise — and can use it commercially. The licenses below govern the *model weights themselves*, not your generated content.
825
804
 
826
805
  | License | Models | Commercial Output |
827
806
  |---------|--------|:-----------------:|
@@ -831,34 +810,24 @@ For every model in this tool, **you own the generated output** — code, text, o
831
810
  | **Llama Community License** | Llama 3.3 70B, Llama 4 Scout/Maverick | ✅ Attribution required. >700M MAU → separate Meta license |
832
811
  | **DeepSeek License** | DeepSeek V3/V3.1/V3.2/V4 family | ✅ Use restrictions on model (no military, no harm) — output is yours |
833
812
  | **NVIDIA Nemotron License** | Nemotron Super/Ultra/Nano | ✅ Updated Mar 2026, now near-Apache 2.0 permissive |
834
- | **MiniMax Model License** | MiniMax M2, M2.5, M3 | ✅ Royalty-free, non-exclusive. Prohibited uses policy applies to model |
813
+ | **MiniMax Model License** | MiniMax M2, M2.5, M3 | ✅ Royalty-free, non-exclusive. Prohibited-uses policy applies to model |
835
814
  | **Proprietary / hosted API terms** | Gemini, GitHub Models, Mistral/Codestral, OpenRouter-hosted models | ✅ Provider ToS applies |
836
815
  | **OpenCode Zen** | Big Pickle, GPT 5 Nano, MiniMax M3 Free, Nemotron 3 Super Free, HY3/Ling/Trinity previews | ✅ Per OpenCode Zen ToS |
837
816
 
838
- ### Key Points
817
+ **Key points:** (1) generated code is yours; (2) Apache 2.0 / permissive families (Qwen, GLM Flash, GPT-OSS, Devstral, Gemma) are the lowest-friction; (3) Llama requires "Built with Llama" attribution, >700M MAU needs a Meta license; (4) DeepSeek / MiniMax have use-restriction policies that govern the model, not your output; (5) API-served models grant output ownership under their current ToS.
839
818
 
840
- 1. **Generated code is yours**no model claims ownership of your output
841
- 2. **Apache 2.0 / permissive model families** (Qwen, GLM Flash, GPT-OSS, Devstral, Gemma) are the lowest-friction options
842
- 3. **Llama** requires "Built with Llama" attribution; >700M MAU needs a Meta license
843
- 4. **DeepSeek / MiniMax** have use-restriction policies (no military use) that govern the model, not your generated code
844
- 5. **API-served models** (Gemini, GitHub Models, OpenRouter, Mistral, etc.) grant output ownership under their current terms of service
845
-
846
- > ⚠️ **Disclaimer:** This is a summary, not legal advice. License terms can change. Always verify the current license on the model's official page before making legal decisions.
819
+ > ⚠️ This is a summary, not legal advice. License terms can change always verify on the model's official page before making legal decisions.
847
820
 
848
821
  ---
849
822
 
850
823
  ## 📊 Telemetry
851
824
 
852
- `free-coding-models` collects anonymous usage telemetry to help understand how the CLI is used and improve the product. No personal information, API keys, prompts, source code, file paths, or secrets are ever collected.
853
-
854
- The telemetry payload is limited to anonymous product analytics such as the app version, selected tool mode, operating system, terminal family, and a random anonymous install ID stored locally on your machine. When a model is launched, telemetry can also include the selected tool, provider, model ID, model label, model tier, launch result, and a few product actions such as installing provider catalogs, saving/removing API keys, or toggling shell environment export.
855
-
856
- Telemetry is enabled by default and can be disabled with any of the following:
825
+ `free-coding-models` collects **anonymous** usage telemetry to understand how the CLI is used and improve the product. No personal information, API keys, prompts, source code, file paths, or secrets are ever collected — only anonymous product analytics (app version, tool mode, OS, terminal family, a random local install ID, and a few product actions like saving keys or installing catalogs).
857
826
 
858
827
  | Method | How |
859
828
  |--------|-----|
860
- | CLI flag | Run `free-coding-models --no-telemetry` |
861
- | Environment variable | Set `FREE_CODING_MODELS_TELEMETRY=0` (also supports `false` or `off`) |
829
+ | CLI flag | `free-coding-models --no-telemetry` |
830
+ | Env var | `FREE_CODING_MODELS_TELEMETRY=0` (also `false` / `off`) |
862
831
 
863
832
  ---
864
833
 
@@ -870,33 +839,21 @@ Telemetry is enabled by default and can be disabled with any of the following:
870
839
  <img src="https://img.shields.io/badge/supply_chain-verified-brightgreen" alt="supply chain verified">
871
840
  </p>
872
841
 
873
- ### Supply Chain
874
-
875
842
  | Signal | Status |
876
843
  |--------|--------|
877
- | **npm Provenance** | ✅ Published with Sigstore-signed provenance |
878
- | **SBOM** | ✅ Software Bill of Materials attached to every GitHub Release |
879
- | **Dependencies** | ✅ 1 runtime dependency (`chalk`) |
880
- | **Lockfile** | ✅ `pnpm-lock.yaml` committed and tracked |
844
+ | **npm Provenance** | ✅ Sigstore-signed |
845
+ | **SBOM** | ✅ Attached to every GitHub Release |
846
+ | **Dependencies** | ✅ 1 runtime (`chalk`) |
847
+ | **Lockfile** | ✅ `pnpm-lock.yaml` tracked |
881
848
  | **Security Policy** | ✅ [`SECURITY.md`](SECURITY.md) |
882
849
  | **Code Owners** | ✅ [`CODEOWNERS`](CODEOWNERS) — all changes require maintainer review |
883
- | **Dependabot** | ✅ Weekly automated dependency + GitHub Actions updates |
884
- | **Audit CI** | ✅ `npm audit` runs on every push/PR + weekly scheduled scan |
850
+ | **Dependabot** | ✅ Weekly automated updates |
851
+ | **Audit CI** | ✅ `npm audit` on every push/PR + weekly scan |
885
852
  | **License** | ✅ MIT |
886
853
 
887
- ### What This Tool Does
888
-
889
- - Pings public API endpoints to measure latency and check availability
890
- - Reads your API keys from `.env` files (only if you configure them)
891
- - Opens configuration files for editing (with your permission)
892
- - Reports anonymous usage data (no personal information — see footer)
893
-
894
- ### What This Tool Does NOT Do
854
+ **What this tool does:** pings public API endpoints to measure latency/availability · reads your API keys from `.env` (only if you configure them) · opens config files for editing (with permission) · reports anonymous usage data.
895
855
 
896
- -Does **not** send your API keys, code, or personal data to any third party
897
- - ❌ Does **not** install or execute arbitrary code beyond `chalk` (the only dependency)
898
- - ❌ Does **not** modify any files outside its own config directory
899
- - ❌ Does **not** require `sudo`, root, or elevated permissions
856
+ **What this tool does NOT do:** never sends your API keys, code, or personal data to any third party · ❌ never installs or executes arbitrary code beyond `chalk` · ❌ never modifies files outside its own config dir · ❌ never requires `sudo`, root, or elevated permissions.
900
857
 
901
858
  > To report a vulnerability, see [`SECURITY.md`](SECURITY.md).
902
859
 
@@ -912,7 +869,7 @@ Telemetry is enabled by default and can be disabled with any of the following:
912
869
  </picture>
913
870
  </a>
914
871
 
915
-
872
+ ---
916
873
 
917
874
  ## Special thanks to contributors
918
875
 
@@ -922,7 +879,7 @@ Telemetry is enabled by default and can be disabled with any of the following:
922
879
  <td align="center" width="120"><a href="https://github.com/erwinh22"><img src="https://avatars.githubusercontent.com/u/6641858?v=4&s=80" width="80" height="80" style="border-radius:50%" alt="erwinh22"></a></td>
923
880
  <td align="center" width="120"><a href="https://github.com/whit3rabbit"><img src="https://avatars.githubusercontent.com/u/12357518?v=4&s=80" width="80" height="80" style="border-radius:50%" alt="whit3rabbit"></a></td>
924
881
  <td align="center" width="120"><a href="https://github.com/skylaweber"><img src="https://avatars.githubusercontent.com/u/172871734?v=4&s=80" width="80" height="80" style="border-radius:50%" alt="skylaweber"></a></td>
925
- <td align="center" width="120"><a href="https://github.com/PhucTruong-ctrl"><img src="https://github.com/PhucTruong-ctrl.png?s=80" width="80" height="80" style="border-radius:50%" alt="PhucTruong-ctrl"></a></td>
882
+ <td align="center" width="120"><a href="https://github.com/PhucTruong-ctrl"><img src="https://avatars.githubusercontent.com/u/PhucTruong-ctrl.png?s=80" width="80" height="80" style="border-radius:50%" alt="PhucTruong-ctrl"></a></td>
926
883
  <td align="center" width="120"><a href="https://github.com/chindris-mihai-alexandru"><img src="https://avatars.githubusercontent.com/u/12643176?v=4&s=80" width="80" height="80" style="border-radius:50%" alt="chindris-mihai-alexandru"></a></td>
927
884
  <td align="center" width="120"><a href="https://github.com/serajbaltu"><img src="https://avatars.githubusercontent.com/u/90699173?v=4&s=80" width="80" height="80" style="border-radius:50%" alt="serajbaltu"></a></td>
928
885
  <td align="center" width="120"><a href="https://github.com/stgreenb"><img src="https://avatars.githubusercontent.com/u/18483964?v=4&s=80" width="80" height="80" style="border-radius:50%" alt="stgreenb"></a></td>
@@ -950,7 +907,7 @@ Telemetry is enabled by default and can be disabled with any of the following:
950
907
 
951
908
  ## 🆓 Other Free AI Resources
952
909
 
953
- **Curated resources outside the active CLI catalog** — IDE extensions, coding agents, GitHub lists, and providers that are useful but not clean enough for the core free-provider table.
910
+ Curated resources kept **outside** the active CLI catalog — IDE extensions, coding agents, GitHub lists, and providers that are useful but not clean enough for the core free-provider table.
954
911
 
955
912
  ### 📚 Awesome Lists (curated by the community)
956
913
 
@@ -977,7 +934,7 @@ Telemetry is enabled by default and can be disabled with any of the following:
977
934
  | [Windsurf](https://windsurf.com/) | 25 prompt credits/month | Required |
978
935
  | [Kilo Code](https://kilocode.ai/) | Up to $25 signup credits (one-time) | Required |
979
936
  | [Tabnine](https://www.tabnine.com/) | Basic completions + chat (limited) | Required |
980
- | [SuperMaven](https://supermaven.com/) | Basic suggestions, 1M token context | Required |
937
+ | [SuperMaven](https://www.supermaven.com/) | Basic suggestions, 1M token context | Required |
981
938
 
982
939
  ### 🔑 API Providers with Permanent Free Tiers
983
940
 
@@ -994,13 +951,13 @@ Telemetry is enabled by default and can be disabled with any of the following:
994
951
  | [Cloudflare Workers AI](https://dash.cloudflare.com) | 10K neurons/day | Llama 3.3 70B, QwQ 32B, 47+ models |
995
952
  | [OVHcloud AI Endpoints](https://endpoints.ai.cloud.ovh.net) | 2 req/min/IP sandbox | GPT-OSS, Qwen3, Mistral |
996
953
 
997
- ### 🧪 Good Candidates Kept Outside the Core Catalog
954
+ ### 🧪 Good candidates kept outside the core catalog
998
955
 
999
- | Provider | Why it is not core |
956
+ | Provider | Why it's not core |
1000
957
  |----------|--------------------|
1001
- | [Vercel AI Gateway](https://vercel.com/docs/ai-gateway) | Useful gateway with included credits, but it is a router/billing layer, not a provider of permanently free models. |
1002
- | [Cohere](https://cohere.com/) | Real evaluation key, but the allowance is small and the catalog is not coding-first enough for the default TUI. |
1003
- | [Ollama Cloud](https://ollama.com/pricing) | Interesting for light cloud usage, but it is closer to hosted Ollama capacity than a classic OpenAI-compatible free provider. |
958
+ | [Vercel AI Gateway](https://vercel.com/docs/ai-gateway) | Useful gateway with included credits, but it's a router/billing layer, not a provider of permanently free models. |
959
+ | [Cohere](https://cohere.com/) | Real evaluation key, but the allowance is small and the catalog isn't coding-first enough for the default TUI. |
960
+ | [Ollama Cloud](https://ollama.com/pricing) | Interesting for light cloud usage, but closer to hosted Ollama capacity than a classic OpenAI-compatible free provider. |
1004
961
 
1005
962
  ### 💰 Providers with Trial Credits
1006
963
 
@@ -1019,12 +976,12 @@ Telemetry is enabled by default and can be disabled with any of the following:
1019
976
  | [Inference.net](https://inference.net) | $1 (+ $25 on survey) | Permanent |
1020
977
  | [Novita](https://novita.ai/) | $0.5 | 1 year |
1021
978
 
1022
- These trial-credit providers are deliberately not treated as core providers unless their free allowance is practical for recurring coding use. A $0.10/month or $1 one-time credit is useful for experimentation, not for this CLI's default promise.
979
+ These trial-credit providers are deliberately not treated as core unless their free allowance is practical for recurring coding use.
1023
980
 
1024
- ### 🎓 Free with Education/Developer Programs
981
+ ### 🎓 Free with Education / Developer Programs
1025
982
 
1026
983
  | Program | What you get |
1027
984
  |---------|--------------|
1028
985
  | [GitHub Student Pack](https://education.github.com/pack) | Free Copilot Pro for students (verify with .edu email) |
1029
986
  | [GitHub Copilot Free](https://code.visualstudio.com/blogs/2024/12/18/free-github-copilot) | 50 chat + 2,000 completions/month in VS Code |
1030
- | [Copilot Pro for teachers/maintainers](https://docs.github.com/en/copilot/how-tos/manage-your-account/get-free-access-to-copilot-pro) | Free Copilot Pro for open source maintainers & educators |
987
+ | [Copilot Pro for teachers/maintainers](https://docs.github.com/en/copilot/how-tos/manage-your-account/get-free-access-to-copilot-pro) | Free Copilot Pro for open-source maintainers & educators |