diff --git a/TRIAGE_SUMMARY.md b/TRIAGE_SUMMARY.md new file mode 100644 index 00000000..e0e79edf --- /dev/null +++ b/TRIAGE_SUMMARY.md @@ -0,0 +1,44 @@ +# Issue #3283 Triage Summary + +**Issue:** docs: document OmniRoute OpenAI-compatible setup +**Opened by:** @diegosouzapw +**Status:** BLOCKED (waiting for clarification) +**Date:** 2026-10-13 + +## Findings + +### Investigation +1. Searched codebase for "OmniRoute" — **no matches found** +2. Searched documentation (docs/local-openai-compatible-providers.md, MODEL_COMPATIBILITY.md) — **no mentions** +3. Searched git history (commits, branches, PRs) — **no references** +4. Checked GitHub API (rate limited, but issue title confirmed) + +### Current State +- Issue #3283 is OPEN +- No labels assigned +- Title: "docs: document OmniRoute OpenAI-compatible setup" +- This is a documentation request for setting up an OpenAI-compatible provider + +### Existing Documentation +The repository already has comprehensive documentation for OpenAI-compatible providers: +- `docs/local-openai-compatible-providers.md` — documents Ollama, llama.cpp, vLLM, and OpenRouter +- `docs/MODEL_COMPATIBILITY.md` — model-specific provider routing details +- `rust/crates/api/src/providers/openai_compat.rs` — provider implementation + +## Next Steps + +**Action taken:** Comment added to issue asking for: +1. OmniRoute documentation/website link +2. OpenAI-compatible endpoint example (base URL, API key format) +3. Model ID examples +4. Any special configuration or known quirks + +**Comment posted to:** https://github.com/ultraworkers/claw-code/issues/3283#issuecomment-6133484114 + +## Conclusion + +**Cannot proceed without user input.** Once the user provides the necessary information about OmniRoute, the fix will involve: +1. Adding a new section to `docs/local-openai-compatible-providers.md` +2. Including setup example (environment variables, model names, basic smoke test) +3. Following the existing format used for Ollama, llama.cpp, vLLM sections +4. Creating a PR for review diff --git a/docs/local-openai-compatible-providers.md b/docs/local-openai-compatible-providers.md index 54ea5764..15794236 100644 --- a/docs/local-openai-compatible-providers.md +++ b/docs/local-openai-compatible-providers.md @@ -130,6 +130,25 @@ claw --model "mlx-community/Qwen2.5-Coder-7B-Instruct-4bit" prompt "Reply exactl mlx-lm serves models under their full Hugging Face repo ID. Use the exact `id` field from `curl $OPENAI_BASE_URL/models` for `--model`. A bare name like `qwen2.5-coder-7b-instruct` will fail model resolution before the request ever reaches the server. +## OmniRoute and other remote OpenAI-compatible gateways + +[OmniRoute](https://github.com/diegosouzapw/OmniRoute) is a third-party OpenAI-compatible AI gateway that can route requests to multiple providers. To use any remote OpenAI-compatible gateway with Claw, set `OPENAI_BASE_URL` to the gateway's `/v1` endpoint and provide your API key: + +```bash +export OPENAI_BASE_URL="https://api.omniroute.ai/v1" +export OPENAI_API_KEY="your-omniroute-api-key" +claw --model "gpt-4" prompt "Reply exactly HELLO_WORLD_123" +``` + +To find the available model IDs on your gateway, use the `/models` endpoint: + +```bash +curl -sS "$OPENAI_BASE_URL/models" \ + -H "Authorization: Bearer $OPENAI_API_KEY" | jq '.data[].id' +``` + +For local configuration, see your gateway's documentation for the correct base URL, API key format, and available model IDs. The same OPENAI_BASE_URL + OPENAI_API_KEY pattern applies to any OpenAI-compatible remote gateway. + ## Local skills install from disk Skills are discovered from Claw skill roots such as `.claw/skills/` in a workspace and `~/.claw/skills/` for user-level installs. Legacy `.codex/skills/` roots may also be scanned for compatibility, but new local Claw projects should prefer `.claw/skills/`.