Skip to content

Commit 38d79d7

Browse files
MrFlounderclaude
andauthored
docs: update README with agent-agnostic support and agent sync (#58)
## Summary - Document agent-agnostic support (Claude Code + Codex CLI) - Add `crab agent sync` command reference - Show `agent:` config field in examples - Update requirements to list both agent CLIs - Update tmux layout diagram and setup flow ## Test plan - [x] README renders correctly - [x] No code changes — docs only 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 880e08a commit 38d79d7

File tree

1 file changed

+29
-8
lines changed

1 file changed

+29
-8
lines changed

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:
@@ -359,6 +374,7 @@ Per-project config (`~/.crabcode/projects/<alias>.yaml`):
359374
360375
```yaml
361376
session_name: pf
377+
agent: claude # or "codex" — defaults to claude if omitted
362378
workspace_base: ~/Dev/my-project-workspaces
363379
main_repo: ~/Dev/my-project
364380
@@ -381,7 +397,7 @@ layout:
381397
- name: server
382398
command: pnpm dev
383399
- name: main
384-
command: claude
400+
command: claude --dangerously-skip-permissions # or: codex --full-auto
385401
386402
# Optional: persistent storage across resets
387403
shared_volume:
@@ -408,14 +424,18 @@ See `examples/` for more configuration examples.
408424
- `OPENAI_API_KEY` or `ANTHROPIC_API_KEY` (for `crab pf`)
409425
- Slack bot token (for `crab pf serve`)
410426

427+
**For AI agents (pick one or both):**
428+
- [Claude Code](https://claude.ai/code): `npm install -g @anthropic-ai/claude-code`
429+
- [Codex CLI](https://github.com/openai/codex): `npm install -g @openai/codex`
430+
411431
**For PR reviews (`crab review`, `crab court`):**
412-
- [gh](https://cli.github.com/), [Claude Code](https://claude.ai/code)
413-
- Optional: [Codex CLI](https://github.com/openai/codex) (for court review)
432+
- [gh](https://cli.github.com/)
433+
- Claude Code and/or Codex CLI (court review uses both)
414434

415435
```bash
416436
# macOS
417437
brew install tmux yq zip gh
418-
npm install -g @anthropic-ai/claude-code
438+
npm install -g @anthropic-ai/claude-code # and/or @openai/codex
419439
```
420440

421441
## Installation
@@ -453,7 +473,7 @@ git pull origin main
453473
┌─────────────────────────┬─────────────────────────┐
454474
│ terminal │ │
455475
│ (shell) │ main │
456-
├─────────────────────────┤ (claude/editor)
476+
├─────────────────────────┤ (claude/codex/editor) │
457477
│ server │ │
458478
│ (pnpm dev) │ │
459479
└─────────────────────────┴─────────────────────────┘
@@ -520,8 +540,9 @@ The restore agent walks through each phase — installing tools, restoring confi
520540
6. **Edit config for your project:**
521541
```bash
522542
# Set your layout commands in ~/.crabcode/projects/<alias>.yaml
543+
# - agent: claude or codex (defaults to claude)
523544
# - server pane: your dev server (e.g., pnpm dev)
524-
# - main pane: your main tool (e.g., claude)
545+
# - main pane: your agent command (e.g., claude --dangerously-skip-permissions, codex --full-auto)
525546
```
526547

527548
7. **Start working:**

0 commit comments

Comments
 (0)