|
3 | 3 | [](https://github.com/coder/cmux/actions/workflows/ci.yml) |
4 | 4 | [](https://github.com/coder/cmux/actions/workflows/build.yml) |
5 | 5 |
|
6 | | -A cross-platform desktop application for managing multiple coding agents. |
| 6 | +A cross-platform desktop application for AI-assisted development with git worktree integration. |
7 | 7 |
|
8 | | -Key features: |
9 | | -- Supports both OpenAI and Anthropic models with consistent interface |
10 | | -- Workspace isolation with git worktrees |
11 | | -- Much richer interface than traditional TUIs |
12 | | - - E.g., ask the agent for an architecture diagram of your codebase |
| 8 | +## Documentation |
13 | 9 |
|
14 | | -## Caveats |
| 10 | +📚 **[Read the full documentation →](https://coder.github.io/cmux)** |
15 | 11 |
|
16 | | -- Early stage, Alpha software |
17 | | -- Built artifacts for macOS and Linux only |
18 | | -- Majority of testing on `claude-sonnet-4-5` |
| 12 | +- [Installation](https://coder.github.io/cmux/install.html) |
| 13 | +- [Keyboard Shortcuts](https://coder.github.io/cmux/keybinds.html) |
| 14 | +- [Developer Guide](https://coder.github.io/cmux/AGENTS.html) |
| 15 | + |
| 16 | +## Quick Install |
| 17 | + |
| 18 | +Download pre-built binaries from [GitHub Actions artifacts](https://github.com/coder/cmux/actions/workflows/build.yml): |
| 19 | + |
| 20 | +- **macOS**: Universal binary DMG (Intel + Apple Silicon) |
| 21 | +- **Linux**: AppImage |
19 | 22 |
|
20 | 23 | ## Development |
21 | 24 |
|
22 | 25 | See [AGENTS.md](./AGENTS.md) for development setup and guidelines. |
| 26 | + |
| 27 | +## Features |
| 28 | + |
| 29 | +- 🔀 Git worktree integration for multi-branch workflows |
| 30 | +- 🤖 Multiple AI permission modes (plan/edit/yolo) |
| 31 | +- 📦 Multi-project management |
| 32 | +- 💬 Persistent session history |
| 33 | +- ⌨️ Keyboard-first interface |
0 commit comments