docs: document OmniRoute OpenAI-compatible setup
还没有人认领这个 Issue。
评估
- 难度
- 1/5
- 预计耗时
- 1-3 小时
- 新手友好度
- 35/100
- Issue 类型
- 文档
- 描述清晰度
- 描述清楚
- 活跃度
- 活跃
- 领域
- cli, documentation
调研方向
Start with docs/local-openai-compatible-providers.md and compare the existing guide with the proposed OmniRoute commands and explanations. Done means the guide contains a copy/paste-safe setup covering the /v1 endpoint, model listing, local/ model IDs, reachability, and provider-dependent streaming and tool compatibility.
由索引模型根据 Issue 内容生成。
描述
Proposal
Add a copy/paste-safe OmniRoute example to the existing
docs/local-openai-compatible-providers.md guide.
Claw already has the required generic runtime behavior:
OPENAI_BASE_URLconfigures the OpenAI-compatible endpoint;- the client appends
/chat/completionswithout duplicating a full endpoint; OPENAI_API_KEYis sent as a Bearer token;- the
local/prefix selects the OpenAI-compatible transport and is removed before the model ID is sent; - the existing client supports SSE and OpenAI-compatible tool-call response shapes.
The proposed documentation would cover:
export OPENAI_BASE_URL="http://localhost:20128/v1"
export OPENAI_API_KEY="replace-with-an-omniroute-api-key"
curl -sS "$OPENAI_BASE_URL/models" \
-H "Authorization: Bearer $OPENAI_API_KEY" \
| jq -r '.data[].id'
claw --model "local/auto" prompt "Reply exactly HELLO_FROM_OMNIROUTE"
The /v1 suffix matters because Claw appends /chat/completions. The full proposal also explains
Docker/host reachability, model IDs containing slashes, and that live streaming/tool compatibility
depends on the selected model/provider behind OmniRoute.
Verification completed
cargo test --workspace: 1,415 passed, 0 failed, 1 ignored;cargo fmt --all --check;cargo clippy --workspace(passes with pre-existing warnings);- documentation source-of-truth and release-readiness checks;
- focused endpoint, streaming, and multiple-tool-call tests;
- real Claw binary against a sanitized local OpenAI-compatible mock;
git diff --check.
Patch availability
A docs-only patch is prepared locally as one commit (de857038b2f9ff9b319132e2241549e86215c351),
changing only docs/local-openai-compatible-providers.md (+37 lines).
I attempted to create/update a GitHub fork for the normal pull-request flow, but GitHub locked the
fork immediately and rejected both Git push and REST ref creation. If maintainers agree with the
documentation direction, I can open the PR as soon as GitHub permits a writable fork, or provide the
exact patch in the preferred form.
- 主要语言
- Rust
- 星标
- 195k
- 派生
- 108k
- PR 合并指标
- 30 天内没有已合并 PR
环境准备
- 提供 Dockerfile 或 Docker Compose 文件
- 有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
ultraworkers/claw-code 的其他 Issue
-
Fix markdown formatting issues in TUI streaming: block-level element newline omission and consecutive empty line accumulation可能重新可做 @Aditaya08 于 51 天前认领，目前没有进行中的 PR。 未关闭
难度 2/5 1-3 小时 新手友好度 78/100
ultraworkers/claw-code#3259 · 7 条评论 ·
-
fix(cli): resolve duplicate assistant text printing after 'Done' in non-compact text mode可能已有人在做 @nankingjing 于 90 天前认领。 未关闭
难度 2/5 1-3 小时 新手友好度 72/100
ultraworkers/claw-code#3258 · 1 条评论 ·
-
bug: Missing newlines before paragraphs and code blocks in streamed Markdown rendering可能已有人在做 @nankingjing 于 90 天前认领。 未关闭
难度 2/5 1-3 小时 新手友好度 78/100
ultraworkers/claw-code#3257 · 2 条评论 ·
-
[CRITICAL][SECURITY] Untrusted project hooks bypass read-only mode for arbitrary command execution未关闭
难度 4/5 3-5 天 新手友好度 68/100
ultraworkers/claw-code#3301 · 4 条评论 ·
-
难度 4/5 3-5 天 新手友好度 20/100
ultraworkers/claw-code#3300 · 2 条评论 ·
查看 ultraworkers/claw-code 的全部 Issue
相似的 Issue
-
[Feature]: [P3] engine-rs: the package source hash should ignore line endings and untracked files未关闭
难度 2/5 1-3 小时 新手友好度 70/100
maniator/verticopolis#880 ·
维护者通常 1 天内回复
-
documentation
难度 2/5 1-3 小时 新手友好度 66/100
维护者通常 3 天内回复
-
defect
难度 2/5 1-3 小时 新手友好度 74/100
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 74/100
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 82/100
维护者通常 2 天内回复