Skip to content

Commit 5b22df4

Browse files
MrFlounderclaude
andcommitted
docs: update README with all current features
Add missing sections: crab pf serve (Slack daemon), crab draw (Excalidraw), sessions, aliases, tickets, P2P messaging. Update requirements and crab pf section with reasoning flag. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 959ba3d commit 5b22df4

1 file changed

Lines changed: 83 additions & 15 deletions

File tree

README.md

Lines changed: 83 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -170,14 +170,47 @@ crab pf --file target.txt # Analyze from file
170170
crab pf "curl -X POST http://..." # Analyze curl command
171171
crab pf --file api.json --output ./config # Specify output dir
172172
crab pf --file spec.yaml --verbose # Show detailed output
173+
crab pf --reasoning high # Set reasoning effort (low/medium/high)
173174
crab pf uninstall # Remove the plugin
174175
```
175176

176177
**Supported formats:** curl commands, OpenAPI specs, Postman collections, Burp exports, plain text descriptions
177178

178179
**Requirements:** Node.js, `OPENAI_API_KEY` or `ANTHROPIC_API_KEY`
179180

180-
The agent probes the target, figures out the protocol (HTTP, WebSocket, polling, etc.), generates the config, and verifies it works.
181+
The agent probes the target, figures out the protocol (HTTP, WebSocket, polling, etc.), generates the config, and verifies it works. Defaults to GPT-5 with `reasoning: low`.
182+
183+
#### Slack Integration (`crab pf serve`)
184+
185+
Let non-technical team members run the discovery agent by DM'ing the Crab bot in Slack. Each user runs their own local daemon with their own API keys.
186+
187+
```bash
188+
crab pf serve --setup # One-time: set Slack username + provider
189+
crab pf serve # Start the polling daemon
190+
crab pf serve -v # Start with verbose output
191+
```
192+
193+
Users DM the bot with `pf:` prefix to trigger the agent:
194+
```
195+
pf: My API is at http://localhost:8080/chat, POST with JSON { "message": "the prompt" }
196+
```
197+
198+
File attachments (API specs, curl commands) are also supported. Results are posted back to the Slack thread as downloadable files.
199+
200+
### Excalidraw Whiteboard (`crab draw`)
201+
202+
Collaborative whiteboarding with real-time collab via Excalidraw.
203+
204+
```bash
205+
crab draw install # Install the plugin
206+
crab draw new "architecture" # Create a new session
207+
crab draw open "architecture" # Open an existing session
208+
crab draw ls # List active sessions
209+
crab draw delete "architecture" # Delete a session
210+
crab draw uninstall # Remove the plugin
211+
```
212+
213+
Sessions support real-time collaboration — share the URL with teammates to draw together.
181214

182215
### PR Review Commands (`crab review`, `crab court`)
183216

@@ -207,13 +240,54 @@ crab review resume <PR> # Resume a review
207240
crab review delete <PR> # Delete a review session
208241
```
209242

243+
### Session Management (`crab session`)
244+
245+
Track and resume Claude conversations across workspaces:
246+
247+
```bash
248+
crab session start "feature-x" # Start a named session
249+
crab session resume "feature-x" # Resume an existing session
250+
crab session ls # List sessions with summaries
251+
crab session delete "feature-x" # Delete a session
252+
```
253+
254+
### Linear Tickets (`crab ticket`)
255+
256+
Open a workspace directly from a Linear ticket:
257+
258+
```bash
259+
crab ticket ENG-1234 # Creates branch, sets up workspace, links ticket
260+
```
261+
262+
### P2P Messaging (`crab msg`)
263+
264+
Peer-to-peer messaging with self-hosted relay:
265+
266+
```bash
267+
crab msg send @user "message" # Send a message
268+
crab msg listen # Listen for incoming messages (with TTS)
269+
crab msg relay # Run your own relay server
270+
```
271+
272+
### Command Aliases (`crab alias`)
273+
274+
Define custom shortcuts for frequently used commands:
275+
276+
```bash
277+
crab alias add deploy "ws 1 restart" # Create an alias
278+
crab alias ls # List aliases
279+
```
280+
281+
Aliases are stored in `~/.crabcode/aliases.yaml`.
282+
210283
### Other Commands
211284

212285
```bash
213286
crab doctor # Diagnose issues
214287
crab ports # Show port usage
215288
crab shared # Show shared volume info
216289
crab cheat # Show cheat sheet
290+
crab update # Self-update to latest version
217291
```
218292

219293
## Setup Flow
@@ -314,26 +388,20 @@ See `examples/` for more configuration examples.
314388
## Requirements
315389

316390
**Core:**
317-
- bash
318-
- tmux
319-
- git
320-
- [yq](https://github.com/mikefarah/yq) (YAML parsing)
321-
- zip (for toolkit share)
391+
- bash, tmux, git, [yq](https://github.com/mikefarah/yq), zip
322392

323-
**For PR reviews (`crab review`, `crab court`):**
324-
- [gh](https://cli.github.com/) (GitHub CLI)
325-
- [Claude Code](https://claude.ai/code) (`claude` CLI)
393+
**For plugins (`crab pf`, `crab draw`):**
394+
- Node.js 20+
395+
- `OPENAI_API_KEY` or `ANTHROPIC_API_KEY` (for `crab pf`)
396+
- Slack bot token (for `crab pf serve`)
326397

327-
**Optional (for court review with Codex):**
328-
- [Codex CLI](https://github.com/openai/codex) (`npm install -g @openai/codex`)
398+
**For PR reviews (`crab review`, `crab court`):**
399+
- [gh](https://cli.github.com/), [Claude Code](https://claude.ai/code)
400+
- Optional: [Codex CLI](https://github.com/openai/codex) (for court review)
329401

330402
```bash
331403
# macOS
332404
brew install tmux yq zip gh
333-
npm install -g @anthropic-ai/claude-code # Claude Code
334-
335-
# Ubuntu/Debian
336-
apt install tmux yq zip gh
337405
npm install -g @anthropic-ai/claude-code
338406
```
339407

0 commit comments

Comments
 (0)