Merge pull request #307 from rowboatlabs/ramnique-patch-5

Update README.md
This commit is contained in:
Ramnique Singh 2025-11-20 16:57:11 +05:30 committed by GitHub
commit e5caddec10
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -46,12 +46,6 @@
Inspired by Claude Code, RowboatX brings the same shell-native power to background automations. Inspired by Claude Code, RowboatX brings the same shell-native power to background automations.
## Quick start ## Quick start
1. Set your LLM API key. Supports OpenAI, Anthropic, Gemini, OpenRouter, LiteLLM, Ollama, and more.
```bash
export OPENAI_API_KEY=your-openai-api-key
```
2. Install RowboatX
```bash ```bash
npx @rowboatlabs/rowboatx npx @rowboatlabs/rowboatx
``` ```
@ -86,15 +80,20 @@ rowboatx --agent=<agent-name> --input="xyz" --no-interactive=true
rowboatx --agent=<agent-name> --run_id=<run_id> # resume from a previous run rowboatx --agent=<agent-name> --run_id=<run_id> # resume from a previous run
``` ```
## Models support ## Models support
You can configure your models in `~/.rowboat/config/models.json` You can configure your models using:
```bash
rowboatx model-config
```
Alternatively, you can directly edit `~/.rowboat/config/models.json`
```json ```json
{ {
"providers": { "providers": {
"openai": { "openai": {
"flavor": "openai" "flavor": "openai"
}, },
"openai-compatible-host": { "lm-studio": {
"flavor": "openai", "flavor": "openai-compatible",
"baseURL": "http://localhost:2000/...", "baseURL": "http://localhost:2000/...",
"apiKey": "...", "apiKey": "...",
"headers": { "headers": {
@ -112,7 +111,7 @@ You can configure your models in `~/.rowboat/config/models.json`
} }
}, },
"defaults": { "defaults": {
"provider": "openai", "provider": "lm-studio",
"model": "gpt-5" "model": "gpt-5"
} }
} }