Skip to content

Commit 699fc7c

Browse files
authored
Simplify README (#141)
1 parent 59d3563 commit 699fc7c

1 file changed

Lines changed: 8 additions & 44 deletions

File tree

README.md

Lines changed: 8 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
[![Last commit](https://img.shields.io/github/last-commit/modem-dev/baudbot)](https://github.com/modem-dev/baudbot/commits/main)
99
[![Security Policy](https://img.shields.io/badge/security-policy-blue)](SECURITY.md)
1010

11-
**Always-on, multiplayer coding agent infrastructure for engineering teams.**
11+
**Always-on, multiplayer dev-assistant for eng teams - write code, act on alerts, and more**
1212

1313
Baudbot runs a persistent AI control agent on Linux, connected to Slack, with worker agents that take tasks from request to PR. It works on real repositories with real tools (git, test runners, Docker wrapper, cloud browser automation), keeps persistent memory, and reports progress back in-thread.
1414

@@ -34,15 +34,6 @@ Baudbot is designed as shared engineering infrastructure, not a single-user desk
3434
- autonomous task execution with humans in review loops
3535
- admin-managed runtime with deployment + rollback controls
3636

37-
## How work flows (example)
38-
39-
1. A developer asks in Slack: "Fix flaky auth tests in `myapp`."
40-
2. Baudbot acknowledges immediately in the same thread.
41-
3. Control agent creates a todo and spawns a `dev-agent` in a fresh git worktree.
42-
4. Dev agent fixes code, runs tests, opens a PR, and monitors CI.
43-
5. If CI fails, the dev agent iterates and pushes fixes automatically.
44-
6. Baudbot posts the PR link, CI status, and preview URL back to the original Slack thread.
45-
4637
## Requirements
4738

4839
| | Minimum | Recommended |
@@ -61,7 +52,7 @@ curl -fsSL https://raw.githubusercontent.com/modem-dev/baudbot/main/bootstrap.sh
6152
baudbot install
6253
```
6354

64-
`baudbot install` includes a guided config flow: pick an LLM provider, choose Slack integration mode (managed broker vs custom app), then opt into optional integrations (Kernel/Sentry). Email capabilities are disabled by default and only available in experimental mode (`baudbot setup --experimental` / `install.sh --experimental`). If [`gum`](https://github.com/charmbracelet/gum) is installed, prompts use richer TUI widgets; otherwise installer falls back to standard bash prompts.
55+
`baudbot install` has a guided config flow: pick an LLM provider, choose Slack integration mode (managed broker vs custom app), then opt into optional integrations (Kernel/Sentry).
6556

6657
After install:
6758

@@ -89,33 +80,19 @@ Install with a specific pi version (optional):
8980
BAUDBOT_PI_VERSION=0.52.12 baudbot install
9081
```
9182

92-
Slack broker registration (after OAuth callback). When `SLACK_BROKER_*` variables are present, the runtime starts broker pull mode (no inbound callback port required):
83+
Slack broker registration:
9384

9485
```bash
95-
sudo baudbot broker register \
96-
--broker-url https://your-broker.example.com \
97-
--workspace-id T0123ABCD \
98-
--registration-token <token-from-dashboard-callback>
86+
sudo baudbot broker register
9987
```
10088

101-
Broker pull mode uses long-polling by default (`SLACK_BROKER_WAIT_SECONDS=20`, max `25`; set `0` for immediate short-poll behavior).
102-
`baudbot broker register` stores broker token fields in env and broker-mode requests include `Authorization: Bearer ...` automatically.
103-
Broker pull mode no longer uses direct Slack Web API fallback and does not require storing `SLACK_BOT_TOKEN`.
104-
10589
Need to rotate/update a key later?
10690

10791
```bash
10892
sudo baudbot env set ANTHROPIC_API_KEY
10993
# or: sudo baudbot env set OPENAI_API_KEY sk-... --restart
11094
```
11195

112-
Want to move source-of-truth off `~/.baudbot/.env` later?
113-
114-
```bash
115-
sudo baudbot env backend set-command 'your-secret-tool export baudbot-prod'
116-
sudo baudbot env sync --restart
117-
```
118-
11996
See [CONFIGURATION.md](CONFIGURATION.md) for required environment variables and secret setup.
12097

12198
## Core agents
@@ -166,23 +143,6 @@ See [SECURITY.md](SECURITY.md) for full threat model, trust boundaries, and know
166143
- [SECURITY.md](SECURITY.md) — deep security model and vulnerability reporting
167144
- [CONTRIBUTING.md](CONTRIBUTING.md) — contribution workflow
168145

169-
## Shell script architecture
170-
171-
Operational shell scripts under `bin/` follow a shared module pattern to keep command entrypoints thin and behavior consistent:
172-
173-
- shared safety/logging/error helpers in `bin/lib/shell-common.sh`
174-
- release lifecycle helpers in `bin/lib/release-common.sh`
175-
- deploy-specific helpers in `bin/lib/deploy-common.sh`
176-
- doctor output/counter helpers in `bin/lib/doctor-common.sh`
177-
- JSON parsing helpers in `bin/lib/json-common.sh`
178-
179-
Conventions:
180-
181-
- source shared modules near the top of each script
182-
- call `bb_enable_strict_mode` (strict bash mode)
183-
- prefer shared `bb_log`/`bb_die` helpers instead of ad-hoc logging/error code
184-
- keep heavy logic in `bin/lib/*` and keep CLI-facing scripts focused on orchestration
185-
186146
## Tests
187147

188148
```bash
@@ -208,3 +168,7 @@ npm run lint:shell
208168
## License
209169

210170
MIT
171+
172+
## About
173+
174+
Brought to you by the team at Modem, your dev team's auto-triage product manager.

0 commit comments

Comments
 (0)