Skip to content

Latest commit

 

History

History
123 lines (101 loc) · 4.34 KB

File metadata and controls

123 lines (101 loc) · 4.34 KB

Providers and models

CodeWiki calls an LLM for module clustering and for writing each page. You pick where those calls go with codewiki config set --provider .... Seven providers are supported. Two of them need no API key at all.

Provider Needs Good for
openai-compatible (default) API key + base URL Any OpenAI-style endpoint: OpenAI, a LiteLLM proxy, vLLM, OpenRouter, and so on
atlas-cloud API key 300+ hosted models behind one OpenAI-compatible API
anthropic API key Direct Anthropic API
azure-openai API key + resource URL + deployment Azure-hosted OpenAI models
bedrock AWS credentials + region Anthropic and other models on AWS Bedrock
claude-code Claude Code CLI logged in Run on a Claude Pro or Max subscription, no per-token billing
codex Codex CLI logged in Run on a Codex subscription, no per-token billing

config set only changes the keys you pass. When you switch provider, pass --main-model and --cluster-model again so no old model name is left over.

API-key providers

# OpenAI-compatible (default)
codewiki config set \
  --provider openai-compatible \
  --api-key YOUR_API_KEY \
  --base-url https://api.example.com/v1 \
  --main-model claude-sonnet-4 \
  --cluster-model claude-sonnet-4 \
  --fallback-model glm-4p5

# Anthropic
codewiki config set \
  --provider anthropic \
  --api-key YOUR_API_KEY \
  --base-url https://api.anthropic.com \
  --main-model claude-sonnet-4 \
  --cluster-model claude-sonnet-4

# Azure OpenAI
codewiki config set \
  --provider azure-openai \
  --api-key YOUR_AZURE_KEY \
  --base-url https://YOUR_RESOURCE.openai.azure.com \
  --azure-deployment YOUR_DEPLOYMENT \
  --main-model gpt-4o \
  --cluster-model gpt-4o

# AWS Bedrock (uses your AWS credentials)
codewiki config set \
  --provider bedrock \
  --aws-region us-east-1 \
  --main-model anthropic.claude-sonnet-4-v2:0 \
  --cluster-model anthropic.claude-sonnet-4-v2:0

Atlas Cloud

Atlas Cloud is an inference platform that exposes LLM, image, and video models behind a single OpenAI-compatible API. The base URL is set for you (https://api.atlascloud.ai/v1), and the key is read from $ATLASCLOUD_API_KEY when --api-key is omitted.

codewiki config set \
  --provider atlas-cloud \
  --main-model anthropic/claude-sonnet-4.6 \
  --cluster-model anthropic/claude-sonnet-4.6 \
  --fallback-model zai-org/GLM-4.6

Browse model IDs at the models endpoint and pick a strong coding model. Their coding plan offers budget-friendly API access.

Subscription mode (no API key)

Subscription mode sends every LLM call through the local claude or codex CLI binary, using the caw library. You pay with your existing subscription instead of per token.

# Claude Code: install the CLI and run `claude login` first
codewiki config set \
  --provider claude-code \
  --main-model claude-sonnet-4-6 \
  --cluster-model claude-sonnet-4-6

# Codex: install the CLI and run `codex login` first
codewiki config set \
  --provider codex \
  --main-model gpt-5.4 \
  --cluster-model gpt-5.5

Things to know:

  • Model names are passed straight to the CLI. Use the bare CLI name (gpt-5.4, claude-sonnet-4-6), not a openai/... or anthropic/... prefix. If you came from openai-compatible, re-run config set with both --main-model and --cluster-model to clear old prefixes.
  • Claude Code's own Write, Edit, and Bash tools are disabled inside CodeWiki's agent loop. All documentation writes go through CodeWiki's editor, which validates Mermaid diagrams.
  • Large repositories can push a module prompt past the CLI's input limit. CodeWiki trims the module tree in that case and retries.

Which model to use

  • The main model writes the pages. It needs strong code understanding and long output. Claude Sonnet-class or GPT-5-class models work well.
  • The cluster model groups components into modules. It reads large inputs and writes a small JSON answer. The same model as main is fine.
  • The fallback model takes over when the main model fails a call. Pick something cheaper that still handles long input.

Check the setup with:

codewiki config show
codewiki config validate