diff --git a/README.md b/README.md index f8d2f38..b7d153c 100644 --- a/README.md +++ b/README.md @@ -125,7 +125,7 @@ claw-code/ | Requirement | Details | |-------------|---------| | ๐Ÿ Python | `3.10` or higher | -| ๐Ÿ–ฅ๏ธ Model Server | `vLLM`, `Ollama`, or `LiteLLM Proxy`, with tool calling support | +| ๐Ÿ–ฅ๏ธ Model Server | `vLLM`, `Ollama`, `LiteLLM Proxy`, or `OpenRouter`, with tool calling support | | ๐Ÿง  Model | [`Qwen/Qwen3-Coder-30B-A3B-Instruct`](https://huggingface.co/Qwen/Qwen3-Coder-30B-A3B-Instruct) (recommended) | --- @@ -207,6 +207,27 @@ Notes: > ๐Ÿ“š **References:** [LiteLLM Docs](https://docs.litellm.ai/) ยท [LiteLLM Proxy Quick Start](https://docs.litellm.ai/) +### Optional: Use OpenRouter + +`claw-code-agent` can also work with [OpenRouter](https://openrouter.ai/), a cloud API gateway that provides access to models from OpenAI, Anthropic, Google, Meta, and others through a single OpenAI-compatible endpoint. No local model server required. + +Configure: + +```bash +export OPENAI_BASE_URL=https://openrouter.ai/api/v1 +export OPENAI_API_KEY=sk-or-v1-your-key-here +export OPENAI_MODEL=openai/gpt-4o-mini +``` + +Notes: + +- sign up at [openrouter.ai](https://openrouter.ai/) and create an API key under [Keys](https://openrouter.ai/keys) +- model names use the `provider/model` format (e.g. `anthropic/claude-sonnet-4`, `openai/gpt-4o`, `google/gemini-2.5-pro`) +- tool calling support varies by model โ€” check the [model list](https://openrouter.ai/models) for capabilities +- this sends your conversation (including file contents and shell output) to OpenRouter and the upstream provider โ€” do not use with repos containing secrets or sensitive data + +> ๐Ÿ“š **References:** [OpenRouter Docs](https://openrouter.ai/docs) ยท [Supported Models](https://openrouter.ai/models) ยท [API Keys](https://openrouter.ai/keys) + ### 2. Configure Environment ```bash