Skip to content

feat: add OrcaRouter as a first-class provider #93

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Marc-oss-hub wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat: add OrcaRouter as a first-class provider #93

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 11 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ codewiki --version

### 2. Configure Your Environment

CodeWiki supports multiple LLM providers: **OpenAI-compatible**, **Atlas Cloud**, **Anthropic**, **AWS Bedrock**, **Azure OpenAI**, plus subscription mode via **Claude Code** and **Codex** CLIs (no API key required).
CodeWiki supports multiple LLM providers: **OpenAI-compatible**, **Atlas Cloud**, **OrcaRouter**, **Anthropic**, **AWS Bedrock**, **Azure OpenAI**, plus subscription mode via **Claude Code** and **Codex** CLIs (no API key required).

```bash
# OpenAI-compatible
Expand All @@ -68,6 +68,14 @@ codewiki config set \
--cluster-model anthropic/claude-sonnet-4.6 \
--fallback-model zai-org/GLM-4.6

# OrcaRouter — base URL auto-set to https://api.orcarouter.ai/v1;
# API key read from $ORCAROUTER_API_KEY when --api-key is omitted.
codewiki config set \
--provider orcarouter \
--main-model anthropic/claude-sonnet-5 \
--cluster-model anthropic/claude-sonnet-5 \
--fallback-model z-ai/glm-4.6

# Anthropic
codewiki config set \
--provider anthropic \
Expand Down Expand Up @@ -110,6 +118,8 @@ codewiki config set \

**About Atlas Cloud.** [Atlas Cloud](https://www.atlascloud.ai) is a full-modal AI inference platform that exposes LLM, image, and video models (300+) behind a single OpenAI-compatible API, so it works with CodeWiki out of the box. Browse model IDs at the [models endpoint](https://api.atlascloud.ai/v1/models) and pick a strong coding model for `--main-model` / `--cluster-model`; their [coding plan](https://www.atlascloud.ai/console/coding-plan) offers budget-friendly API access.

**About OrcaRouter.** [OrcaRouter](https://www.orcarouter.ai) is a fast, cost-aware AI gateway that routes every call through OpenAI- and Anthropic-compatible endpoints, so it works with CodeWiki out of the box. It also runs gateway-level, zero-trust security for AI agents on the same endpoint — screening every prompt/response and governing every tool call on a default-deny basis, with no application code changes. Browse model IDs at the [models endpoint](https://api.orcarouter.ai/v1/models) and pick a strong coding model for `--main-model` / `--cluster-model`.

**Subscription mode** routes every LLM call through the local `claude` / `codex` CLI binary (via the [`caw`](https://github.com/zzjas/caw) library), so you can run CodeWiki on a Claude Pro/Max or Codex subscription instead of paying per-token API usage. Claude Code's built-in `Write`/`Edit`/`Bash` tools are disabled inside CodeWiki's agent loop so documentation writes still go through CodeWiki's Mermaid-validating editor.

> **Note on model names.** In subscription mode the model string is forwarded directly to `claude --model` / `codex --model`, so use the bare CLI model name (e.g. `gpt-5.4`, `claude-sonnet-4-6`) — **not** the litellm-style `openai/…` or `anthropic/…` prefix used by `openai-compatible`. If you previously ran with `openai-compatible`, re-run `config set` for **both** `--main-model` and `--cluster-model` to clear any stale prefixes; `config set` only updates the keys you pass.
Expand Down
18 changes: 17 additions & 1 deletion codewiki/cli/commands/config.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,12 +87,13 @@ def config_group():
@click.option(
"--provider",
type=click.Choice(
['openai-compatible', 'atlas-cloud', 'anthropic', 'bedrock', 'azure-openai', 'claude-code', 'codex'],
['openai-compatible', 'atlas-cloud', 'orcarouter', 'anthropic', 'bedrock', 'azure-openai', 'claude-code', 'codex'],
case_sensitive=False,
),
help=(
"LLM provider type (default: openai-compatible). "
"Use 'atlas-cloud' for Atlas Cloud (base URL auto-set; reads ATLASCLOUD_API_KEY). "
"Use 'orcarouter' for OrcaRouter (base URL auto-set; reads ORCAROUTER_API_KEY). "
"Use 'claude-code' or 'codex' to run on a CLI subscription instead of an API key."
),
)
Expand Down Expand Up @@ -159,6 +160,11 @@ def config_set(
# API key read from ATLASCLOUD_API_KEY if --api-key is omitted
$ codewiki config set --provider atlas-cloud --main-model <atlas-model> --cluster-model <atlas-model>

\b
# OrcaRouter (OpenAI-compatible) — base URL auto-set,
# API key read from ORCAROUTER_API_KEY if --api-key is omitted
$ codewiki config set --provider orcarouter --main-model <model> --cluster-model <model>

\b
# Subscription mode (Claude Code) — no API key needed,
# authenticate via 'claude login' on the host first
Expand Down Expand Up @@ -204,6 +210,16 @@ def config_set(
if not api_key:
api_key = os.getenv("ATLASCLOUD_API_KEY")

# OrcaRouter convenience defaults: it's an OpenAI-compatible endpoint, so
# auto-fill its base URL and pull the API key from ORCAROUTER_API_KEY when
# the user does not pass them explicitly.
if provider and provider.lower() == "orcarouter":
from codewiki.src.config import ORCAROUTER_BASE_URL
if not base_url:
base_url = ORCAROUTER_BASE_URL
if not api_key:
api_key = os.getenv("ORCAROUTER_API_KEY")

# Validate inputs before saving
validated_data = {}

Expand Down
2 changes: 1 addition & 1 deletion codewiki/cli/models/config.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ class Configuration:
cluster_model: Model for module clustering
fallback_model: Fallback model for documentation generation
default_output: Default output directory
provider: LLM provider type (openai-compatible, atlas-cloud, anthropic, bedrock, azure-openai)
provider: LLM provider type (openai-compatible, atlas-cloud, orcarouter, anthropic, bedrock, azure-openai)
aws_region: AWS region for Bedrock provider
api_version: Azure OpenAI API version
azure_deployment: Azure OpenAI deployment name
Expand Down
8 changes: 6 additions & 2 deletions codewiki/src/config.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,10 @@ def is_cli_context() -> bool:
# when the user selects the `atlas-cloud` provider without passing --base-url.
ATLAS_CLOUD_BASE_URL = "https://api.atlascloud.ai/v1"

# OrcaRouter default endpoint (OpenAI-compatible). Used to auto-fill the base URL
# when the user selects the `orcarouter` provider without passing --base-url.
ORCAROUTER_BASE_URL = "https://api.orcarouter.ai/v1"

@dataclass
class Config:
"""Configuration class for CodeWiki."""
Expand All @@ -70,7 +74,7 @@ class Config:
cluster_model: str
fallback_model: str = FALLBACK_MODEL_1
# Provider configuration
provider: str = "openai-compatible" # openai-compatible, atlas-cloud, anthropic, bedrock, azure-openai
provider: str = "openai-compatible" # openai-compatible, atlas-cloud, orcarouter, anthropic, bedrock, azure-openai
aws_region: str = "us-east-1"
api_version: str = "2024-12-01-preview" # Azure OpenAI API version
azure_deployment: str = "" # Azure OpenAI deployment name
Expand Down Expand Up @@ -205,7 +209,7 @@ def from_cli(
main_model: Primary model
cluster_model: Clustering model
fallback_model: Fallback model
provider: LLM provider type (openai-compatible, atlas-cloud, anthropic, bedrock, azure-openai)
provider: LLM provider type (openai-compatible, atlas-cloud, orcarouter, anthropic, bedrock, azure-openai)
aws_region: AWS region for Bedrock provider
api_version: Azure OpenAI API version
azure_deployment: Azure OpenAI deployment name
Expand Down