Skip to content

Commit 013715b

Browse files
mldangeloclaude
andcommitted
docs: update llms.txt to reflect current platform capabilities
Rewrite llms.txt to cover all features shipped through v0.9.1: multi-project support, PR review/court, ticket integration, P2P messaging, command aliases, and session management. Update config paths from legacy single-project format to per-project layout at ~/.crabcode/projects/<alias>.yaml. Fix init question count (3, not 2). Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 5496807 commit 013715b

1 file changed

Lines changed: 124 additions & 8 deletions

File tree

docs/llms.txt

Lines changed: 124 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,14 @@
99

1010
> Lightning-fast tmux workspace manager for multi-repo development
1111

12-
Crabcode creates isolated development workspaces using git worktrees and tmux. Each workspace gets its own branch, ports, and tmux layout. Switch between tasks instantly without losing context.
12+
Crabcode creates isolated development workspaces using git worktrees and tmux. Each workspace gets its own branch, ports, and tmux layout. Manage multiple projects from a single install. Switch between tasks instantly without losing context.
1313

1414
## Installation
1515

1616
```bash
1717
# Prerequisites
18-
brew install tmux yq zip # macOS
19-
# apt install tmux yq zip # Linux
18+
brew install tmux yq zip gh # macOS
19+
# apt install tmux yq zip gh # Linux
2020

2121
# Install crabcode
2222
curl -fsSL https://raw.githubusercontent.com/promptfoo/crabcode/main/install.sh | bash
@@ -26,8 +26,9 @@ curl -fsSL https://raw.githubusercontent.com/promptfoo/crabcode/main/install.sh
2626

2727
```bash
2828
cd ~/Dev/my-project
29-
crab init # 2 questions: repo path + workspace dir
29+
crab init # 3 questions: repo path, alias, workspace dir
3030
crab config scan # auto-detect .env files and ports
31+
crab ws 1 # start first workspace
3132
```
3233

3334
## Usage
@@ -42,14 +43,76 @@ crab restart # Reset git + restart panes
4243
crab cleanup # Full teardown, reset to origin/main
4344
```
4445

46+
### Multi-Project
47+
48+
Manage multiple repos from a single crabcode install. Each project gets an alias.
49+
50+
```bash
51+
crab @pf ws 1 # Open workspace 1 for project "pf"
52+
crab @cb config # Show config for project "cb"
53+
crab ws 1 # Uses default project (or detects from cwd)
54+
crab projects # List all registered projects
55+
crab projects rm <alias> # Remove a project registration
56+
crab default pf # Set default project
57+
```
58+
59+
Project configs live in `~/.crabcode/projects/<alias>.yaml`. Commands auto-detect which project you're in based on cwd.
60+
4561
### Save & Restore Work
4662

4763
```bash
4864
crab wip save # Save current changes
4965
crab wip save --restart # Save then restart workspace
5066
crab wip --continue # Restore most recent saved state
5167
crab wip --resume # Interactive selection of saved states
52-
crab wip ls # List all saved states
68+
crab wip ls # List all saved states globally
69+
```
70+
71+
### PR Review & Court
72+
73+
Two modes for reviewing pull requests:
74+
75+
```bash
76+
# Quick single-agent review
77+
crab review 3230 # PR number
78+
crab review promptfoo#456 # Submodule PR
79+
crab review https://github.com/... # Full URL
80+
81+
# Court review - multi-agent tribunal with judge pattern
82+
crab court 3230 # Judge + 2 reviewers
83+
```
84+
85+
Court review uses the judge pattern: a Judge (Claude) orchestrates two independent reviewers (Claude teammate + Codex), verifies every finding against actual code, resolves disagreements, and delivers a verdict with zero false positives.
86+
87+
```bash
88+
crab review ls # List review sessions
89+
crab review show <PR> # View saved review output
90+
crab review resume <PR> # Resume a review
91+
crab review delete <PR> # Delete a review session
92+
crab review delete --all # Delete all review sessions
93+
```
94+
95+
### Ticket Integration
96+
97+
Create workspaces from Linear ticket identifiers with automatic context injection:
98+
99+
```bash
100+
crab ticket ENG-123 # Provision workspace from ticket
101+
crab ws 3 ticket ENG-123 # Bind ticket to specific workspace
102+
```
103+
104+
### P2P Messaging
105+
106+
Peer-to-peer messaging via self-hosted relay server:
107+
108+
```bash
109+
crab msg start # Start relay server
110+
crab msg @user "message" # Send message to peer
111+
crab msg read # View inbox
112+
crab msg listen # Real-time message stream
113+
crab msg say on/off # Toggle text-to-speech for incoming messages
114+
crab msg history # View message history
115+
crab msg stop # Stop relay server
53116
```
54117

55118
### Share Files
@@ -58,6 +121,7 @@ crab wip ls # List all saved states
58121
crab tk share <path> # Upload → temp URL
59122
crab tk share <path> --to slack:#channel # Share to Slack
60123
crab tk share <path> --to ssh:user@host # SSH transfer
124+
crab tk share <path> --to email:addr # Email attachment
61125
crab tk share <path> --serve # Local HTTP + QR code
62126
```
63127

@@ -69,14 +133,38 @@ crab slack #channel "message" # Post to channel
69133
crab slack read @user # View recent messages
70134
crab slack chat @user # Interactive terminal chat
71135
crab slack sent # View sent messages log
136+
crab slack users # List workspace users
72137
```
73138

74-
Requires `slack.bot_token` in `~/.crabcode/config.yaml`.
139+
Requires `slack.bot_token` in project config.
140+
141+
### Command Aliases
142+
143+
Define custom shorthand for frequently-used workflows:
144+
145+
```bash
146+
crab alias set rr restart # Set alias
147+
crab alias set d "ws 1" # Multi-word commands
148+
crab alias # List all aliases
149+
crab alias rm rr # Remove alias
150+
```
151+
152+
### Session Management
153+
154+
Track and resume named Claude conversations:
155+
156+
```bash
157+
crab session ls # List sessions
158+
crab session start "name" # Start named session
159+
crab session resume "name" # Resume existing session
160+
crab session delete "name" # Delete a session
161+
```
75162

76163
### Other Commands
77164

78165
```bash
79166
crab config # Show current configuration
167+
crab config scan # Auto-detect .env files and ports
80168
crab ports # Show port usage across workspaces
81169
crab shared # Show shared volume info
82170
crab doctor # Diagnose issues
@@ -85,13 +173,30 @@ crab cheat # Show cheat sheet
85173

86174
## Configuration
87175

88-
Config file: `~/.crabcode/config.yaml`
176+
```
177+
~/.crabcode/
178+
config.yaml # global prefs (default_project, aliases)
179+
projects/
180+
pf.yaml # per-project config
181+
cb.yaml # per-project config
182+
wip/
183+
pf/ # per-project WIP isolation
184+
cb/
185+
sessions/
186+
pf/ # per-project session storage
187+
```
188+
189+
Per-project config (`~/.crabcode/projects/<alias>.yaml`):
89190

90191
```yaml
91-
session_name: crab
192+
session_name: pf
92193
workspace_base: ~/Dev/my-project-workspaces
93194
main_repo: ~/Dev/my-project
94195

196+
workspaces:
197+
prefix: ws
198+
branch_pattern: workspace-{N}
199+
95200
# Port isolation (auto-detected by 'crab config scan')
96201
env_sync:
97202
files:
@@ -128,6 +233,9 @@ slack:
128233
- **WIP**: Save/restore your uncommitted changes across workspace resets
129234
- **Shared Volume**: A `.local/` folder that persists across resets for experiments
130235
- **Port Isolation**: Each workspace gets offset ports (ws1: 3001, ws2: 3002, etc.)
236+
- **Court Review**: Multi-agent PR review using the judge pattern (judge + 2 reviewers)
237+
- **P2P Messaging**: Self-hosted relay for developer-to-developer messaging with TTS
238+
- **Command Aliases**: User-defined shorthand stored in global config
131239

132240
## Tmux Layout
133241

@@ -147,6 +255,14 @@ Keybindings (prefix: `Ctrl+a`):
147255
- `Ctrl+a z` - Toggle zoom
148256
- `Option+arrows` - Navigate panes
149257

258+
## Requirements
259+
260+
**Core:** bash, tmux, git, [yq](https://github.com/mikefarah/yq), zip
261+
262+
**For PR reviews:** [gh](https://cli.github.com/) (GitHub CLI), [Claude Code](https://claude.ai/code) (`claude` CLI)
263+
264+
**Optional:** [Codex CLI](https://github.com/openai/codex) (for court review with Codex reviewer)
265+
150266
## Links
151267

152268
- Website: https://crabcode.dev

0 commit comments

Comments
 (0)