Update README.md

This commit is contained in:
Ramnique Singh 2025-11-20 16:51:26 +05:30 committed by GitHub
parent e15faf6696
commit b23ea564b7
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -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
[![Screenshot](https://github.com/user-attachments/assets/ab46ff8b-44bd-400e-beb0-801c6431033f)](https://www.youtube.com/watch?v=cyPBinQzicY&t) [![Screenshot](https://github.com/user-attachments/assets/ab46ff8b-44bd-400e-beb0-801c6431033f)](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"
} }
} }