Skip to content

Commit f132fce

Browse files
MrFlounderclaude
andcommitted
docs: update README with agent-agnostic support and crab agent sync
- Add agent-agnostic description and Codex CLI mention - Document `crab agent sync` command (status, mcp, agents) - Show `agent:` field in config example - Update requirements to list both Claude Code and Codex CLI - Update tmux layout diagram and setup flow Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 1e12db8 commit f132fce

1 file changed

Lines changed: 29 additions & 8 deletions

File tree

README.md

Lines changed: 29 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
< >
88
```
99

10-
A lightning-fast tmux-based workspace manager for multi-repo development. Manage multiple projects, start full dev environments in seconds.
10+
A lightning-fast tmux-based workspace manager for multi-repo development. Agent-agnostic — works with both [Claude Code](https://claude.ai/code) and [Codex CLI](https://github.com/openai/codex). Manage multiple projects, start full dev environments in seconds.
1111

1212
## Quick Start
1313

@@ -242,7 +242,7 @@ crab review delete <PR> # Delete a review session
242242

243243
### Session Management (`crab session`)
244244

245-
Track and resume Claude conversations across workspaces:
245+
Track and resume agent conversations across workspaces:
246246

247247
```bash
248248
crab session start "feature-x" # Start a named session
@@ -251,6 +251,21 @@ crab session ls # List sessions with summaries
251251
crab session delete "feature-x" # Delete a session
252252
```
253253

254+
### Agent Sync (`crab agent`)
255+
256+
Sync user-level configurations (MCP servers, custom agents/skills) between Claude Code and Codex CLI. Useful when switching a project's agent or maintaining parity across both.
257+
258+
```bash
259+
crab agent status # Audit what's configured on each side
260+
crab agent sync mcp --from claude # Preview MCP server sync (dry run)
261+
crab agent sync mcp --from claude --apply # Sync MCP servers Claude → Codex
262+
crab agent sync agents --from claude # Preview agent → skill rewrites (dry run)
263+
crab agent sync agents --from claude --apply # Rewrite Claude agents as Codex skills (LLM-assisted)
264+
crab agent sync all --apply # Sync everything both directions
265+
```
266+
267+
MCP sync is mechanical (JSON↔TOML translation). Agent/skill sync uses whichever LLM CLI is available to rewrite between formats. Dry-run by default.
268+
254269
### Linear Tickets (`crab ticket`)
255270

256271
Open a workspace directly from a Linear ticket:
@@ -346,6 +361,7 @@ Per-project config (`~/.crabcode/projects/<alias>.yaml`):
346361
347362
```yaml
348363
session_name: pf
364+
agent: claude # or "codex" — defaults to claude if omitted
349365
workspace_base: ~/Dev/my-project-workspaces
350366
main_repo: ~/Dev/my-project
351367
@@ -368,7 +384,7 @@ layout:
368384
- name: server
369385
command: pnpm dev
370386
- name: main
371-
command: claude
387+
command: claude --dangerously-skip-permissions # or: codex --full-auto
372388
373389
# Optional: persistent storage across resets
374390
shared_volume:
@@ -395,14 +411,18 @@ See `examples/` for more configuration examples.
395411
- `OPENAI_API_KEY` or `ANTHROPIC_API_KEY` (for `crab pf`)
396412
- Slack bot token (for `crab pf serve`)
397413

414+
**For AI agents (pick one or both):**
415+
- [Claude Code](https://claude.ai/code): `npm install -g @anthropic-ai/claude-code`
416+
- [Codex CLI](https://github.com/openai/codex): `npm install -g @openai/codex`
417+
398418
**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)
419+
- [gh](https://cli.github.com/)
420+
- Claude Code and/or Codex CLI (court review uses both)
401421

402422
```bash
403423
# macOS
404424
brew install tmux yq zip gh
405-
npm install -g @anthropic-ai/claude-code
425+
npm install -g @anthropic-ai/claude-code # and/or @openai/codex
406426
```
407427

408428
## Installation
@@ -440,7 +460,7 @@ git pull origin main
440460
┌─────────────────────────┬─────────────────────────┐
441461
│ terminal │ │
442462
│ (shell) │ main │
443-
├─────────────────────────┤ (claude/editor)
463+
├─────────────────────────┤ (claude/codex/editor) │
444464
│ server │ │
445465
│ (pnpm dev) │ │
446466
└─────────────────────────┴─────────────────────────┘
@@ -491,8 +511,9 @@ With prefix `Ctrl+a`:
491511
6. **Edit config for your project:**
492512
```bash
493513
# Set your layout commands in ~/.crabcode/projects/<alias>.yaml
514+
# - agent: claude or codex (defaults to claude)
494515
# - server pane: your dev server (e.g., pnpm dev)
495-
# - main pane: your main tool (e.g., claude)
516+
# - main pane: your agent command (e.g., claude --dangerously-skip-permissions, codex --full-auto)
496517
```
497518

498519
7. **Start working:**

0 commit comments

Comments
 (0)