mirror of
https://github.com/rowboatlabs/rowboat.git
synced 2026-04-25 00:16:29 +02:00
Update README.md
This commit is contained in:
parent
e15faf6696
commit
b23ea564b7
1 changed files with 12 additions and 13 deletions
25
README.md
25
README.md
|
|
@ -46,15 +46,9 @@
|
||||||
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
|
||||||
```bash
|
npx @rowboatlabs/rowboatx
|
||||||
export OPENAI_API_KEY=your-openai-api-key
|
```
|
||||||
```
|
|
||||||
|
|
||||||
2. Install RowboatX
|
|
||||||
```bash
|
|
||||||
npx @rowboatlabs/rowboatx
|
|
||||||
```
|
|
||||||
|
|
||||||
## Demo
|
## Demo
|
||||||
[](https://www.youtube.com/watch?v=cyPBinQzicY&t)
|
[](https://www.youtube.com/watch?v=cyPBinQzicY&t)
|
||||||
|
|
@ -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"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue