Skip to content

Documentation: Added Anthropic documentation #392

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
ShubhanC wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Documentation: Added Anthropic documentation #392

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
2 changes: 2 additions & 0 deletions .env.example
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
# Default model to use (must exist in providers.json).
# Ollama examples: "gemma4:latest", "qwen3:4b", "mistral:7b"
# Gemini examples: "gemini-2.5-pro", "gemini-2.5-flash"
# Anthropic examples: "claude-haiku-4-5", "claude-sonnet-5", "claude-opus-4-8"
DEFAULT_MODEL=gemma4:latest

# API keys — only needed for providers whose api_key_env is set in providers.json.
GEMINI_API_KEY=your_gemini_api_key_here
ANTHROPIC_API_KEY=your_anthropic_api_key_here
9 changes: 8 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -186,8 +186,9 @@ $ cp .env.example .env

| Variable | Values | Description |
| ---------------- | ------------------------------------------- | ---------------------------------------------------------------------- |
| `DEFAULT_MODEL` | for example `gemma4:latest` or `gemini-2.5-pro` | Model to use; must exist in `providers.json` — the provider is inferred from which provider lists it. Defaults to `default_model` in `providers.json`. |
| `DEFAULT_MODEL` | for example `gemma4:latest`, `gemini-2.5-flash`, or `claude-sonnet-5` | Model to use; must exist in `providers.json` — the provider is inferred from which provider lists it. Defaults to `default_model` in `providers.json`. |
| `GEMINI_API_KEY` | string | Required when using a Gemini model. |
| `ANTHROPIC_API_KEY` | string | Required when using a Anthropic model. |
| `GITHUB_TOKEN` | optional | Inherits from your shell environment, improves GitHub API rate limits. |

Provider mapping lives in `providers.json` — each provider declares its `base_url`, an optional API-key env var, and per-model parameters; `config.py` loads it and resolves the provider for a model. `config.py` also has a flag:
Expand Down Expand Up @@ -344,6 +345,12 @@ role directory instead.
- Provide `GEMINI_API_KEY`
- The same `models.OpenAICompatibleProvider` wrapper is used, pointed at Gemini's OpenAI-compatible endpoint

### Anthropic

- Set `DEFAULT_MODEL` to an Anthropic model listed in `providers.json`, for example `claude-sonnet-5`
- Provide `ANTHROPIC_API_KEY`
- The same `models.OpenAICompatibleProvider` wrapper is used, pointed at Anthropic's OpenAI-compatible endpoint

---

## Contributing
Expand Down