MoonshotAI / MoonshotAI/kimi-cli

docs: document OmniRoute OpenAI-compatible provider setup

Open Beginner friendly
#2,576 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
11.4k
Forks
1.3k
Avg merge
9h 47m
Merged PRs (30d)
2

Description

Problem

Kimi Code CLI already supports manually configured OpenAI-compatible providers, but the provider
documentation does not show a reproducible gateway configuration for OmniRoute users. The base URL,
model declaration, and environment-variable mapping are easy to misconfigure.

Proposed documentation

  • Show OmniRoute through the existing openai_legacy provider, without provider-specific runtime
    code.
  • Use http://localhost:20128/v1 as the OpenAI-compatible base URL.
  • Declare the model ID and max_context_size manually because custom providers do not perform model
    discovery.
  • Explain that openai_legacy reads OPENAI_API_KEY, including how to map an existing
    OMNIROUTE_API_KEY for one process.
  • Mention container/remote-host reachability and the existing Responses/Anthropic provider
    alternatives.
  • Keep the English and Chinese provider documentation aligned.

Prepared validation

  • 47 focused tests passed for LLM creation, OpenAI Chat Completions, and Responses.
  • The VitePress documentation build passed.
  • git diff --check passed.
  • No remote credential or endpoint was used.

The prepared documentation change is under 100 lines and does not alter runtime behavior. If this
direction matches the maintainers' expectations, I can submit the corresponding pull request.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the English and Chinese provider documentation and the existing openai_legacy setup. Document the OmniRoute base URL, model and context settings, API-key mapping, reachability notes, and provider alternatives in both languages, then run the VitePress documentation build and confirm the pages remain aligned.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Quiet
Clarity
Clearly specified
Newbie friendliness
72/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.