55
66![ cmux product screenshot] ( docs/img/product-hero.webp )
77
8- A cross-platform desktop application for embarassingly parallel development.
8+ A cross-platform desktop application for parallel agentic development.
9+
10+ ## Features
11+
12+ The overall experience should be familiar to Claude Code power users, we strive for parity with the best parts of Claude Code:
13+
14+ - Plan/Exec modes
15+ - ` /compact ` based manual compaction
16+ - vim mode in input box
17+
18+ But, the agentic loop is custom. Our goal is to create an experience that is as immersive and rich as an IDE. In fact, we think
19+ of cmux as the IDE of the future. We go beyond Claude Code with:
20+
21+ - Live git status updates for each workspace
22+ - Workspace isolation
23+ - Worktrees today, Docker containers / remote compute tomorrow
24+ - [ More compaction control] ( https://cmux.io/context-management.html )
25+ - Automatic resumption after app restart
26+ - Rich markdown rendering of plans and assistant messages
27+ - Mermaid diagrams
28+ - LaTeX
29+ - Toggles!
930
1031## Documentation
1132
@@ -25,37 +46,3 @@ Download pre-built binaries from [GitHub Actions artifacts](https://github.com/c
2546## Development
2647
2748See [ AGENTS.md] ( ./AGENTS.md ) for development setup and guidelines.
28-
29- ### Documentation Style Guide
30-
31- When writing user-facing documentation, follow these principles:
32-
33- ** Minimum Viable Documentation** - Write only what users need to complete their task successfully. Assume users are:
34-
35- - Capable of using basic UIs without instruction
36- - Able to debug issues without pre-written troubleshooting
37- - Smart enough to apply security best practices without being told
38-
39- ** Delete:**
40-
41- - Step-by-step UI walkthroughs for obvious interactions ("Click the button", "Enter the value", "Click Save")
42- - Troubleshooting sections for hypothetical problems that haven't occurred
43- - Best practices and security advice (users will research when needed)
44- - Multiple ways to do the same thing (pick one, preferably the simplest)
45- - Verification/testing sections
46-
47- ** Keep:**
48-
49- - Core setup steps with technical details
50- - Non-obvious facts about how things work
51- - Actual command examples
52- - Brief, clear explanations
53-
54- ## Features
55-
56- - 🔀 Git worktree integration for multi-branch workflows
57- - 🤖 Multiple AI permission modes (plan/edit)
58- - 📦 Multi-project management
59- - 💬 Persistent session history
60- - ⌨️ Keyboard-first interface
61- - Command Palette (` Cmd+Shift+P ` / ` Ctrl+Shift+P ` )
0 commit comments