@smart-coders-hq/opencode-model-fallback 1.0.1

package/LICENSE

@@ -0,0 +1,190 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to the Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by the Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding any notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2025 Błażej Pawlak / Smart Coders s.c.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,237 @@
+# opencode-model-fallback
+
+OpenCode plugin that adds automatic model fallback when your primary model hits a rate limit or quota. Instead of waiting in a retry loop, it immediately switches to the next healthy model in a configured chain — per-agent, with a health state machine that tracks recovery.
+
+## How it works
+
+1. **Preemptive redirect** — intercepts outgoing messages via `chat.message` hook; if the target model is known to be rate-limited, redirects the message to a healthy fallback _before_ it hits the provider (no 429 round-trip)
+2. **Reactive fallback** — if a 429 still occurs (first hit, or preemptive not available), listens for `session.status: retry` events, aborts the retry loop, reverts the failed message, and replays it with the next healthy fallback model
+3. Shows an inline toast notification and logs the event
+4. Tracks model health globally (rate limits are account-wide) — automatically recovers after configurable cooldown periods
+5. **Depth reset** — when the TUI reverts to the original model between messages, `fallbackDepth` resets so `maxFallbackDepth` only guards true cascading failures within a single message
+
+## Installation
+
+Add to the `plugin` array in your `~/.config/opencode/opencode.jsonc`:
+
+```jsonc
+{
+  "plugin": [
+    // ... existing plugins
+    "@smart-coders-hq/opencode-model-fallback",
+  ],
+}
+```
+
+Or load locally during development:
+
+```jsonc
+{
+  "plugin": ["file:///path/to/opencode-model-fallback/dist/index.js"],
+}
+```
+
+Then create a config file (see [Configuration](#configuration)).
+
+## Configuration
+
+Place `model-fallback.json` at either:
+
+- `.opencode/model-fallback.json` — project-local
+- `~/.config/opencode/model-fallback.json` — global
+
+```json
+{
+  "enabled": true,
+  "defaults": {
+    "fallbackOn": [
+      "rate_limit",
+      "quota_exceeded",
+      "5xx",
+      "timeout",
+      "overloaded"
+    ],
+    "cooldownMs": 300000,
+    "retryOriginalAfterMs": 900000,
+    "maxFallbackDepth": 3
+  },
+  "agents": {
+    "*": {
+      "fallbackModels": [
+        "anthropic/claude-sonnet-4-20250514",
+        "google/gemini-flash-2-5"
+      ]
+    }
+  },
+  "patterns": [
+    "rate limit",
+    "usage limit",
+    "too many requests",
+    "quota exceeded",
+    "overloaded",
+    "capacity exceeded",
+    "credits exhausted",
+    "billing limit",
+    "429"
+  ],
+  "logging": true,
+  "logPath": "~/.local/share/opencode/logs/model-fallback.log"
+}
+```
+
+### All config fields
+
+| Field                           | Type     | Default                                           | Description                                                              |
+| ------------------------------- | -------- | ------------------------------------------------- | ------------------------------------------------------------------------ |
+| `enabled`                       | boolean  | `true`                                            | Enable/disable the plugin                                                |
+| `defaults.fallbackOn`           | string[] | all categories                                    | Error categories that trigger fallback                                   |
+| `defaults.cooldownMs`           | number   | `300000` (5 min)                                  | How long before a rate-limited model enters cooldown. Min: 10000         |
+| `defaults.retryOriginalAfterMs` | number   | `900000` (15 min)                                 | How long before a cooldown model is considered healthy again. Min: 10000 |
+| `defaults.maxFallbackDepth`     | number   | `3`                                               | Maximum number of fallbacks per session. Max: 10                         |
+| `agents`                        | object   | `{"*": {}}`                                       | Per-agent fallback chains (see below)                                    |
+| `patterns`                      | string[] | see defaults                                      | Case-insensitive substrings to match in retry messages                   |
+| `logging`                       | boolean  | `true`                                            | Write structured logs to `logPath`                                       |
+| `logPath`                       | string   | `~/.local/share/opencode/logs/model-fallback.log` | Log file path (must be within `$HOME`)                                   |
+
+### Error categories
+
+- `rate_limit` — 429, "rate limit", "too many requests", "usage limit"
+- `quota_exceeded` — "quota exceeded", "credits exhausted", "billing limit"
+- `overloaded` — "overloaded", "capacity exceeded"
+- `timeout` — "timeout", "timed out"
+- `5xx` — 500/502/503/504, "internal server error", "bad gateway"
+
+## Per-agent chains
+
+Configure different fallback chains for different agents using the agent name as the key. The `"*"` wildcard is used for any agent without a specific entry.
+
+```json
+{
+  "agents": {
+    "build": {
+      "fallbackModels": [
+        "anthropic/claude-sonnet-4-20250514",
+        "google/gemini-3-pro",
+        "openai/gpt-4o"
+      ]
+    },
+    "coder": {
+      "fallbackModels": ["anthropic/claude-sonnet-4-20250514"]
+    },
+    "*": {
+      "fallbackModels": [
+        "anthropic/claude-sonnet-4-20250514",
+        "google/gemini-flash-2-5"
+      ]
+    }
+  }
+}
+```
+
+Models are tried in order. Rate-limited models are skipped; cooldown models are used as a last resort.
+
+## Migrating from opencode-rate-limit-fallback
+
+If you have an existing `rate-limit-fallback.json` config, the plugin auto-migrates it on load — no manual steps needed.
+
+**Old format:**
+
+```json
+{
+  "fallbackModel": "anthropic/claude-opus-4-5",
+  "cooldownMs": 300000,
+  "patterns": ["rate limit"],
+  "logging": true
+}
+```
+
+**Automatically converted to:**
+
+```json
+{
+  "agents": { "*": { "fallbackModels": ["anthropic/claude-opus-4-5"] } },
+  "defaults": { "cooldownMs": 300000 },
+  "patterns": ["rate limit"],
+  "logging": true
+}
+```
+
+The plugin checks both `rate-limit-fallback.json` and `model-fallback.json` — old configs are found and migrated automatically.
+
+## `/fallback-status` command
+
+Run `/fallback-status` in any OpenCode session to see:
+
+- Current session's fallback depth and history
+- Health state of all tracked models (healthy / cooldown / rate_limited) with time remaining
+- Which agent is active
+
+With the `verbose` flag:
+
+```
+/fallback-status verbose:true
+```
+
+Includes token/cost breakdown per model period.
+
+## Health state machine
+
+```
+healthy ──[rate limit detected]──→ rate_limited
+rate_limited ──[cooldownMs elapsed]──→ cooldown
+cooldown ──[retryOriginalAfterMs elapsed]──→ healthy
+```
+
+- **healthy** — model is usable; preferred for fallback selection
+- **rate_limited** — recently hit a limit; skipped when walking fallback chain
+- **cooldown** — cooling off; used as last resort if no healthy model is available
+- State transitions are checked every 30 seconds via a background timer
+- When the original model recovers to healthy, a toast appears on the next `session.idle`
+
+## Troubleshooting
+
+**Toast doesn't appear**
+The TUI notification requires an active OpenCode TUI session. Headless/API usage won't show toasts but logs are always written.
+
+**"no fallback chain configured"**
+Your `model-fallback.json` has no `agents["*"].fallbackModels` (or no entry for the active agent). Add at least a wildcard entry with one model.
+
+**"all fallback models exhausted"**
+All configured fallback models are currently rate-limited. Wait for `cooldownMs` to elapse or add more models to the chain.
+
+**"max fallback depth reached"**
+The session has hit `maxFallbackDepth` cascading fallbacks within a single message (all models failing in sequence). Depth resets automatically when the TUI reverts to the original model between messages, so this typically indicates all configured models are rate-limited simultaneously. Start a new session or increase `maxFallbackDepth` in config.
+
+**Check the logs:**
+
+```bash
+tail -f ~/.local/share/opencode/logs/model-fallback.log | jq .
+```
+
+Key log events: `plugin.init`, `retry.detected`, `fallback.success`, `fallback.exhausted`, `health.transition`, `recovery.available`
+
+## Release automation
+
+- Uses **Conventional Commits** + `semantic-release` for automated versioning/changelog/release notes
+- CI runs lint, tests, type check, and build on every push/PR via `.github/workflows/ci.yml`
+- Release workflow runs on `main` after successful CI via `.github/workflows/release.yml`
+- Published as `@smart-coders-hq/opencode-model-fallback`
+- To publish to npm, set repository secret `NPM_TOKEN`
+
+## Development
+
+```bash
+bun install
+bun run lint          # lint checks
+bun test              # 101 tests
+bunx tsc --noEmit     # type check
+bun run build         # build to dist/
+```
+
+Load locally in OpenCode:
+
+```jsonc
+{ "plugin": ["file:///absolute/path/to/dist/index.js"] }
+```
+
+Config for testing: place `model-fallback.json` in `.opencode/` in your project directory.

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export { createPlugin } from "./src/plugin.js";
+export type { Plugin } from "@opencode-ai/plugin";
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAC/C,YAAY,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC"}