rowboat/README.md

157 lines
4.8 KiB
Markdown
Raw Normal View History

![ui](https://github.com/user-attachments/assets/fdf0679f-b107-48ce-b326-04db752838d9)
2025-01-13 15:05:09 +05:30
2025-04-03 19:58:39 +05:30
<h5 align="center">
2025-05-29 20:47:56 +05:30
<p align="center" style="display: flex; justify-content: center; gap: 20px; align-items: center;">
<a href="https://trendshift.io/repositories/13609" target="blank">
<img src="https://trendshift.io/api/badge/repositories/13609" alt="rowboatlabs%2Frowboat | Trendshift" width="250" height="55"/>
</a>
</p>
<p align="center">
2025-05-29 23:24:16 +05:30
<a href="https://discord.gg/rxB8pzHxaS" target="_blank" rel="noopener">
<img alt="Discord" src="https://img.shields.io/badge/Discord-5865F2?logo=discord&logoColor=white&labelColor=5865F2">
</a>
2025-11-18 23:51:01 +05:30
<a href="https://www.rowboatx.com/" target="_blank" rel="noopener">
2025-05-29 20:47:56 +05:30
<img alt="Website" src="https://img.shields.io/badge/Website-10b981?labelColor=10b981&logo=window&logoColor=white">
</a>
2025-08-20 00:11:33 +05:30
<a href="https://x.com/intent/user?screen_name=rowboatlabshq" target="_blank" rel="noopener">
<img alt="Twitter" src="https://img.shields.io/twitter/follow/rowboatlabshq?style=social">
</a>
2025-05-29 20:47:56 +05:30
<a href="https://www.ycombinator.com" target="_blank" rel="noopener">
<img alt="Y Combinator" src="https://img.shields.io/badge/Y%20Combinator-S24-orange">
</a>
</p>
2025-11-26 13:14:41 +05:30
# RowboatX - Claude Code for Everyday Automations
2025-04-03 19:58:39 +05:30
</h5>
2025-11-17 22:08:40 +05:30
RowboatX is a local-first CLI for creating background AI agents with full shell access.
**Example agents you can create:**
- Research every person before your meetings (Exa search MCP + Google Calendar MCP)
- Daily podcast summarizing your saved articles (ElevenLabs MCP + ffmpeg)
- Auto-triage Slack DMs and draft responses while you sleep (Slack MCP)
2025-04-03 19:58:39 +05:30
2025-04-07 16:13:49 +05:30
## Quick start
2025-11-20 16:51:26 +05:30
```bash
2025-11-20 17:12:39 +05:30
npx @rowboatlabs/rowboatx@latest
2025-11-20 16:51:26 +05:30
```
2025-01-14 12:28:44 +05:30
2025-11-18 22:52:26 +05:30
## Demo
2025-11-19 00:30:24 +05:30
[![Screenshot](https://github.com/user-attachments/assets/ab46ff8b-44bd-400e-beb0-801c6431033f)](https://www.youtube.com/watch?v=cyPBinQzicY&t)
2025-01-14 12:28:44 +05:30
2025-11-17 23:35:49 +05:30
## Examples
### Add and Manage MCP servers
`$ rowboatx`
- Add MCP: 'Add this MCP server config: \<config\> '
- Explore tools: 'What tools are there in \<server-name\> '
### Create background agents
`$ rowboatx`
- 'Create agent to do X.'
- '... Attach the correct tools from \<mcp-server-name\> to the agent'
- '... Allow the agent to run shell commands including ffmpeg'
### Schedule and monitor agents
`$ rowboatx`
- 'Make agent \<background-agent-name\> run every day at 10 AM'
- 'What agents do I have scheduled to run and at what times'
- 'When was \<background-agent-name\> last run'
- 'Are any agents waiting for my input or confirmation'
### Run background agents manually
``` bash
rowboatx --agent=<agent-name> --input="xyz" --no-interactive=true
```
```bash
2025-11-18 22:57:39 +05:30
rowboatx --agent=<agent-name> --run_id=<run_id> # resume from a previous run
2025-11-17 23:35:49 +05:30
```
## Models support
2025-11-20 16:51:26 +05:30
You can configure your models using:
```bash
rowboatx model-config
```
Alternatively, you can directly edit `~/.rowboat/config/models.json`
```json
{
"providers": {
"openai": {
"flavor": "openai"
},
2025-11-20 16:51:26 +05:30
"lm-studio": {
"flavor": "openai-compatible",
2025-11-19 01:21:54 +05:30
"baseURL": "http://localhost:2000/...",
"apiKey": "...",
"headers": {
"foo": "bar"
}
},
"anthropic": {
"flavor": "anthropic"
},
"google": {
"flavor": "google"
},
"ollama": {
"flavor": "ollama"
}
},
"defaults": {
2025-11-20 16:51:26 +05:30
"provider": "lm-studio",
"model": "gpt-5"
}
}
```
2025-11-26 22:09:54 +05:30
## Contributing
We want help with:
- **Agent templates** - Pre-built agents others can use (podcast generator, meeting prep, etc.)
- **MCP server integrations** - Add support for new tools
- **Platform support** - Windows improvements, Linux edge cases
```bash
git clone git@github.com:rowboatlabs/rowboat.git
cd rowboat
npm install
npm run build
npm link
rowboatx
```
Ping us on [Discord](https://discord.com/invite/rxB8pzHxaS) if you want to discuss before building.
2025-11-26 13:14:41 +05:30
---
2025-11-26 22:09:54 +05:30
## Prefer a Web UI: Rowboat Studio
*Cursor for Multi-agent Workflows*
2025-11-26 13:14:41 +05:30
⚡ Build AI agents instantly with natural language | 🔌 Connect tools with one-click integrations | 📂 Power with knowledge by adding documents for RAG | 🔄 Automate workflows by setting up triggers and actions | 🚀 Deploy anywhere via API or SDK<br><br>
2025-11-26 22:09:54 +05:30
### Quick start
2025-11-26 13:14:41 +05:30
1. Set your OpenAI key
```bash
export OPENAI_API_KEY=your-openai-api-key
```
2. Clone the repository and start Rowboat (requires Docker)
```bash
./start.sh
```
3. Access the app at [http://localhost:3000](http://localhost:3000).
#### Create a multi-agent assistant with MCP tools by chatting with Rowboat
[![meeting-prep](https://github.com/user-attachments/assets/c8a41622-8e0e-459f-becb-767503489866)](https://youtu.be/KZTP4xZM2DY)
2025-11-26 22:09:54 +05:30
See [Docs](https://docs.rowboatlabs.com/) for more details.
2025-11-26 13:14:41 +05:30
---
2025-11-26 22:09:54 +05:30
<div align="center">
Made with ❤️ by the Rowboat team
2025-11-26 13:14:41 +05:30
2025-11-26 22:09:54 +05:30
[Discord](https://discord.gg/rxB8pzHxaS) · [Twitter](https://x.com/intent/user?screen_name=rowboatlabshq)
</div>