Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

docs: document OmniRoute OpenAI-compatible setup

Đang mở
  • Có gì không ổn?
#3,283 4 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Đánh giá

Độ khó
1/5
Thời gian dự kiến
1-3 giờ
Mức phù hợp với người mới
35/100
Loại issue
Tài liệu
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
rust, shell
Lĩnh vực
cli, documentation

Hướng nghiên cứu

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.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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_URL configures the OpenAI-compatible endpoint;
  • the client appends /chat/completions without duplicating a full endpoint;
  • OPENAI_API_KEY is 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.

Ngôn ngữ chính
Rust
Star
195k
Fork
108k
Không có pull request nào được merge trong 30 ngày

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của ultraworkers/claw-code

Tất cả issue của ultraworkers/claw-code

Issue tương tự

Thêm issue về Rust

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.