Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

docs: document OmniRoute OpenAI-compatible setup

Aperta
  • Qualcosa non va?
#3,283 4 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
1/5
Tempo stimato
1-3 ore
Idoneità per principianti
35/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
rust, shell
Ambito
cli, documentation

Direzione di ricerca

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.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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.

Lingua principale
Rust
Stelle
195k
Fork
108k
Nessuna PR unita negli ultimi 30g

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di ultraworkers/claw-code

Tutte le issue di ultraworkers/claw-code

Issue simili

Altre issue su Rust

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.