Skip to content

Commit 6b935d0

Browse files
committed
Add comprehensive USAGE guide, provider key template, and fix opencodezen default model
Introduce docs/USAGE.md with step-by-step walkthrough covering installation, API key setup, agent CLI, chat TUI, approvals, model selection (including full opencodezen-go model list), and troubleshooting. Add scripts/provider_keys.zsh template for one-time key setup with preservation of existing env vars. Update README quick start to reference the new guide. Fix opencodezen-go default model from the placeholder name to deepseek-v4-flash.
1 parent ba2c0d7 commit 6b935d0

4 files changed

Lines changed: 448 additions & 5 deletions

File tree

README.md

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -67,15 +67,23 @@ pip install -e ".[security]"
6767

6868
## Quick Start
6969

70+
**New to TeaAgent?** See the [Quick Start Guide](docs/USAGE.md) for a step-by-step walkthrough covering API key setup, agent mode, chat mode, approvals, and troubleshooting.
71+
7072
```bash
71-
# Check provider configuration
73+
# 1. Set up API keys (one-time)
74+
cp scripts/provider_keys.zsh ~/.teaagent/provider_keys.zsh
75+
# Edit the file and fill in your keys, then:
76+
echo 'source ~/.teaagent/provider_keys.zsh' >> ~/.zshrc
77+
source ~/.zshrc
78+
79+
# 2. Verify setup
7280
teaagent doctor model gpt
7381

74-
# Run an inspect-only task
82+
# 3. Run an inspect-only task
7583
teaagent agent run gpt "Summarize the test suite" --permission-mode read-only
7684

77-
# Start interactive TUI
78-
teaagent tui
85+
# 4. Start interactive TUI
86+
teaagent tui --chat
7987
```
8088

8189
### Environment Variables

0 commit comments

Comments
 (0)