Skip to content

Commit 0a8e6d5

Browse files
committed
Document local LLM providers (Ollama/vLLM) and TLS env vars in usage and CLI docs
1 parent 1328cc7 commit 0a8e6d5

2 files changed

Lines changed: 40 additions & 8 deletions

File tree

docs/USAGE.md

Lines changed: 24 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -29,17 +29,19 @@ teaagent --help
2929

3030
## API Key Setup
3131

32-
TeaAgent supports 5 LLM providers. Set environment variables for the ones you want to use:
32+
TeaAgent supports 7 LLM providers. Set environment variables for the ones you want to use:
3333

3434
| Provider | Env Var | Default Model | Get Key |
3535
|-----------|------------------------|------------------------|--------------------------------------------------|
3636
| claude | `ANTHROPIC_API_KEY` | claude-3-5-sonnet-latest | https://console.anthropic.com/settings/keys |
3737
| gpt | `OPENAI_API_KEY` | gpt-4o-mini | https://platform.openai.com/api-keys |
3838
| gemini | `GEMINI_API_KEY` | gemini-1.5-flash | https://aistudio.google.com/apikey |
3939
| openrouter| `OPENROUTER_API_KEY` | openai/gpt-4o-mini | https://openrouter.ai/settings/keys |
40+
| ollama | `OLLAMA_API_KEY` (optional) | llama3.2 | Local server (default `http://localhost:11434/v1`) |
41+
| vllm | `VLLM_API_KEY` (optional) | meta-llama/Llama-3.1-8B-Instruct | Local server (default `http://localhost:8000/v1`) |
4042
| opencodezen-go | `OPENCODEZEN_API_KEY` | deepseek-v4-flash* | https://opencode.ai/settings |
4143

42-
\* The `opencodezen-go` provider's default model name is `opencodezen-go`, but the API requires a real model name like `deepseek-v4-flash`. Always pass `--model` with this provider (see [Choosing a Model](#choosing-a-model)).
44+
\* `opencodezen-go` defaults to `deepseek-v4-flash`. You can still pass `--model` to pick another supported model.
4345

4446
### Lazy Setup (Recommended)
4547

@@ -60,9 +62,22 @@ source ~/.zshrc
6062
```bash
6163
export ANTHROPIC_API_KEY="sk-ant-..."
6264
export OPENAI_API_KEY="sk-..."
65+
export OPENROUTER_API_KEY="sk-or-..."
66+
export OLLAMA_BASE_URL="http://localhost:11434/v1"
67+
export VLLM_BASE_URL="http://localhost:8000/v1"
6368
# ... etc
6469
```
6570

71+
Network/TLS environment variables are also supported:
72+
73+
```bash
74+
export HTTPS_PROXY="http://proxy.internal:8080"
75+
export REQUESTS_CA_BUNDLE="/path/to/ca-bundle.pem"
76+
export SSL_CERT_FILE="/path/to/ca-bundle.pem"
77+
export TEAAGENT_TLS_CLIENT_CERT="/path/to/client.crt"
78+
export TEAAGENT_TLS_CLIENT_KEY="/path/to/client.key"
79+
```
80+
6681
### Override Default Models
6782

6883
Set environment variables to change the default model per provider:
@@ -72,7 +87,6 @@ export CLAUDE_MODEL="claude-3-5-sonnet-latest"
7287
export GPT_MODEL="gpt-4o"
7388
export GEMINI_MODEL="gemini-2.0-flash"
7489
export OPENROUTER_MODEL="anthropic/claude-3.5-sonnet"
75-
export OPENCODEZEN_GO_MODEL="deepseek-v4-flash"
7690
```
7791

7892
Or override with `--model` on the command line (see below).
@@ -84,6 +98,8 @@ Check that your key is detected:
8498
```bash
8599
teaagent doctor model gpt
86100
teaagent doctor model claude
101+
teaagent doctor model ollama
102+
teaagent doctor model vllm
87103
teaagent doctor model opencodezen-go
88104
```
89105

@@ -123,7 +139,7 @@ teaagent agent run gpt "do something"
123139

124140
### Using a Specific Model
125141

126-
Some providers (especially `opencodezen-go`) need an explicit model:
142+
Use `--model` when you want to override defaults:
127143

128144
```bash
129145
teaagent agent run --model deepseek-v4-flash opencodezen-go "list all Python files"
@@ -205,7 +221,7 @@ teaagent> ask which ones are test files?
205221
| `session switch <id>` | Switch to a saved session |
206222
| `ask <task>` | Run an agent task |
207223
| `ask --clarify <task>` | Run with ambiguity check first |
208-
| `provider <name>` | Set LLM provider (gpt, claude, gemini, openrouter, opencodezen-go) |
224+
| `provider <name>` | Set LLM provider (gpt, claude, gemini, openrouter, ollama, vllm, opencodezen-go) |
209225
| `model <name>` | Override model name |
210226
| `permission <mode>` | Set permission mode |
211227
| `destructive on/off` | Toggle destructive tool access |
@@ -287,7 +303,7 @@ The `opencodezen-go` provider at `https://opencode.ai/zen/go/v1` supports these
287303
| `mimo-v2.5` | |
288304
| `hy3-preview` | |
289305

290-
Always pass `--model` with `opencodezen-go`:
306+
To pick a specific `opencodezen-go` model explicitly:
291307

292308
```bash
293309
teaagent agent run --model deepseek-v4-flash opencodezen-go "your task"
@@ -319,7 +335,7 @@ teaagent agent run gpt "do something"
319335

320336
### "opencodezen-go response missing text content"
321337

322-
The `opencodezen-go` provider default model name is `opencodezen-go`, which is not a real model name. Always pass an explicit model:
338+
Use an explicit model when you want one of the higher-capability `opencodezen-go` variants:
323339

324340
```bash
325341
teaagent agent run --model deepseek-v4-flash opencodezen-go "your task"
@@ -383,4 +399,4 @@ note read
383399
- Full CLI reference: [docs/cli.md](cli.md)
384400
- Architecture: [docs/architecture.md](architecture.md)
385401
- Tool authoring: [docs/tool-authoring.md](tool-authoring.md)
386-
- Provider authoring: [docs/provider-authoring.md](provider-authoring.md)
402+
- Provider authoring: [docs/provider-authoring.md](provider-authoring.md)

docs/cli.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -180,6 +180,8 @@ teaagent doctor model claude
180180
teaagent doctor model gpt
181181
teaagent doctor model gemini
182182
teaagent doctor model openrouter
183+
teaagent doctor model ollama
184+
teaagent doctor model vllm
183185
teaagent doctor model opencodezen-go
184186
```
185187

@@ -207,6 +209,8 @@ export ANTHROPIC_API_KEY=...
207209
export OPENAI_API_KEY=...
208210
export GEMINI_API_KEY=...
209211
export OPENROUTER_API_KEY=...
212+
export OLLAMA_API_KEY=... # optional for local deployments
213+
export VLLM_API_KEY=... # optional for local deployments
210214
export OPENCODEZEN_API_KEY=...
211215
```
212216

@@ -217,9 +221,21 @@ export ANTHROPIC_BASE_URL=https://api.anthropic.com/v1
217221
export OPENAI_BASE_URL=https://api.openai.com/v1
218222
export GEMINI_BASE_URL=https://generativelanguage.googleapis.com/v1beta
219223
export OPENROUTER_BASE_URL=https://openrouter.ai/api/v1
224+
export OLLAMA_BASE_URL=http://localhost:11434/v1
225+
export VLLM_BASE_URL=http://localhost:8000/v1
220226
export OPENCODEZEN_BASE_URL=https://opencode.ai/zen/go/v1
221227
```
222228

229+
Optional proxy/TLS settings:
230+
231+
```bash
232+
export HTTPS_PROXY=http://proxy.internal:8080
233+
export REQUESTS_CA_BUNDLE=/path/to/ca-bundle.pem
234+
export SSL_CERT_FILE=/path/to/ca-bundle.pem
235+
export TEAAGENT_TLS_CLIENT_CERT=/path/to/client.crt
236+
export TEAAGENT_TLS_CLIENT_KEY=/path/to/client.key
237+
```
238+
223239
## Workspace Tools
224240

225241
List the repo-operation tool metadata that will be exposed to the agent runner:

0 commit comments

Comments
 (0)