From 2f14a1a04f28b4dd3896c666317bc65ae6afcaf5 Mon Sep 17 00:00:00 2001 From: ChinmayShringi Date: Sat, 7 Feb 2026 14:38:40 -0500 Subject: [PATCH] docs: add ANTHROPIC_BASE_URL support for custom endpoints Add documentation for using custom Anthropic-compatible API endpoints (like Kimi K2.5, AWS Bedrock, etc.) without needing router mode. Users can now set ANTHROPIC_BASE_URL directly in .env to route requests to any Anthropic-compatible endpoint. Fixes #69 --- .env.example | 11 +++++++++++ CLAUDE.md | 13 +++++++++++++ README.md | 13 +++++++++++++ 3 files changed, 37 insertions(+) diff --git a/.env.example b/.env.example index b9aab986..d0596272 100644 --- a/.env.example +++ b/.env.example @@ -26,6 +26,17 @@ ANTHROPIC_API_KEY=your-api-key-here # OPENROUTER_API_KEY=sk-or-your-openrouter-key # ROUTER_DEFAULT=openrouter,google/gemini-3-flash-preview +# ============================================================================= +# OPTION 3: Custom Anthropic-Compatible Endpoint (no router) +# ============================================================================= +# Use any Anthropic-compatible API (Kimi K2.5, AWS Bedrock, etc.) directly +# without the router. Just set the base URL and your API key: +# +# ANTHROPIC_BASE_URL=https://your-custom-endpoint.com/v1 +# ANTHROPIC_API_KEY=your-api-key-for-custom-endpoint +# +# Then run normally: ./shannon start URL= REPO= + # ============================================================================= # Available Models # ============================================================================= diff --git a/CLAUDE.md b/CLAUDE.md index c73d3c96..529ed62b 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -268,6 +268,19 @@ The tool should only be used on systems you own or have explicit permission to t **Output:** - `audit-logs/{hostname}_{sessionId}/` - Session metrics, agent logs, deliverables +### Custom Anthropic-Compatible Endpoint + +Use any Anthropic API-compatible endpoint (Kimi K2.5, AWS Bedrock, etc.) without the router: + +```bash +# In .env: +ANTHROPIC_BASE_URL=https://api.example.com/v1 +ANTHROPIC_API_KEY=your-api-key + +# Run normally (no ROUTER=true needed): +./shannon start URL= REPO= +``` + ### Router Mode (Multi-Model Support) Shannon supports routing Claude Agent SDK requests through alternative LLM providers via [claude-code-router](https://github.com/musistudio/claude-code-router). diff --git a/README.md b/README.md index 1ec4552c..6b1bd2bc 100644 --- a/README.md +++ b/README.md @@ -258,6 +258,19 @@ rules: If your application uses two-factor authentication, simply add the TOTP secret to your config file. The AI will automatically generate the required codes during testing. +### Custom Anthropic-Compatible Endpoint + +Use any Anthropic API-compatible endpoint (Kimi K2.5, AWS Bedrock, etc.) without the router: + +```bash +# In .env: +ANTHROPIC_BASE_URL=https://api.example.com/v1 +ANTHROPIC_API_KEY=your-api-key + +# Run normally: +./shannon start URL=https://example.com REPO=/path/to/repo +``` + ### [EXPERIMENTAL - UNSUPPORTED] Router Mode (Alternative Providers) Shannon can experimentally route requests through alternative AI providers using claude-code-router. This mode is not officially supported and is intended primarily for: