219 lines
8.3 KiB
Markdown
219 lines
8.3 KiB
Markdown
<h1 align="center">cmux</h1>
|
||
<p align="center">A Ghostty-based macOS terminal with vertical tabs and notifications for AI coding agents</p>
|
||
|
||
<p align="center">
|
||
<a href="https://github.com/manaflow-ai/cmux/releases/latest/download/cmux-macos.dmg">
|
||
<img src="./docs/assets/macos-badge.png" alt="Download cmux for macOS" width="180" />
|
||
</a>
|
||
</p>
|
||
|
||
<p align="center">
|
||
English | <a href="README.zh-CN.md">简体中文</a> | <a href="README.zh-TW.md">繁體中文</a> | <a href="README.ko.md">한국어</a> | <a href="README.de.md">Deutsch</a> | <a href="README.es.md">Español</a> | <a href="README.fr.md">Français</a> | <a href="README.it.md">Italiano</a> | <a href="README.da.md">Dansk</a> | <a href="README.ja.md">日本語</a> | <a href="README.pl.md">Polski</a> | <a href="README.ru.md">Русский</a> | <a href="README.bs.md">Bosanski</a> | <a href="README.ar.md">العربية</a> | <a href="README.no.md">Norsk</a> | <a href="README.pt-BR.md">Português (Brasil)</a> | <a href="README.th.md">ไทย</a> | <a href="README.tr.md">Türkçe</a>
|
||
</p>
|
||
|
||
<p align="center">
|
||
<img src="./docs/assets/main-first-image.png" alt="cmux screenshot" width="900" />
|
||
</p>
|
||
|
||
<p align="center">
|
||
<a href="https://www.youtube.com/watch?v=i-WxO5YUTOs">▶ Demo video</a>
|
||
</p>
|
||
|
||
## Features
|
||
|
||
<table>
|
||
<tr>
|
||
<td width="40%" valign="middle">
|
||
<h3>Notification rings</h3>
|
||
Panes get a blue ring and tabs light up when coding agents need your attention
|
||
</td>
|
||
<td width="60%">
|
||
<img src="./docs/assets/notification-rings.png" alt="Notification rings" width="100%" />
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td width="40%" valign="middle">
|
||
<h3>Notification panel</h3>
|
||
See all pending notifications in one place, jump to the most recent unread
|
||
</td>
|
||
<td width="60%">
|
||
<img src="./docs/assets/sidebar-notification-badge.png" alt="Sidebar notification badge" width="100%" />
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td width="40%" valign="middle">
|
||
<h3>In-app browser</h3>
|
||
Split a browser alongside your terminal with a scriptable API ported from <a href="https://github.com/vercel-labs/agent-browser">agent-browser</a>
|
||
</td>
|
||
<td width="60%">
|
||
<img src="./docs/assets/built-in-browser.png" alt="Built-in browser" width="100%" />
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td width="40%" valign="middle">
|
||
<h3>Vertical + horizontal tabs</h3>
|
||
Sidebar shows git branch, working directory, listening ports, and latest notification text. Split horizontally and vertically.
|
||
</td>
|
||
<td width="60%">
|
||
<img src="./docs/assets/vertical-horizontal-tabs-and-splits.png" alt="Vertical tabs and split panes" width="100%" />
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
|
||
- **Scriptable** — CLI and socket API to create workspaces, split panes, send keystrokes, and automate the browser
|
||
- **Native macOS app** — Built with Swift and AppKit, not Electron. Fast startup, low memory.
|
||
- **Ghostty compatible** — Reads your existing `~/.config/ghostty/config` for themes, fonts, and colors
|
||
- **GPU-accelerated** — Powered by libghostty for smooth rendering
|
||
|
||
## Install
|
||
|
||
### DMG (recommended)
|
||
|
||
<a href="https://github.com/manaflow-ai/cmux/releases/latest/download/cmux-macos.dmg">
|
||
<img src="./docs/assets/macos-badge.png" alt="Download cmux for macOS" width="180" />
|
||
</a>
|
||
|
||
Open the `.dmg` and drag cmux to your Applications folder. cmux auto-updates via Sparkle, so you only need to download once.
|
||
|
||
### Homebrew
|
||
|
||
```bash
|
||
brew tap manaflow-ai/cmux
|
||
brew install --cask cmux
|
||
```
|
||
|
||
To update later:
|
||
|
||
```bash
|
||
brew upgrade --cask cmux
|
||
```
|
||
|
||
On first launch, macOS may ask you to confirm opening an app from an identified developer. Click **Open** to proceed.
|
||
|
||
## Why cmux?
|
||
|
||
I run a lot of Claude Code and Codex sessions in parallel. I was using Ghostty with a bunch of split panes, and relying on native macOS notifications to know when an agent needed me. But Claude Code's notification body is always just "Claude is waiting for your input" with no context, and with enough tabs open I couldn't even read the titles anymore.
|
||
|
||
I tried a few coding orchestrators but most of them were Electron/Tauri apps and the performance bugged me. I also just prefer the terminal since GUI orchestrators lock you into their workflow. So I built cmux as a native macOS app in Swift/AppKit. It uses libghostty for terminal rendering and reads your existing Ghostty config for themes, fonts, and colors.
|
||
|
||
The main additions are the sidebar and notification system. The sidebar has vertical tabs that show git branch, working directory, listening ports, and the latest notification text for each workspace. The notification system picks up terminal sequences (OSC 9/99/777) and has a CLI (`cmux notify`) you can wire into agent hooks for Claude Code, OpenCode, etc. When an agent is waiting, its pane gets a blue ring and the tab lights up in the sidebar, so I can tell which one needs me across splits and tabs. Cmd+Shift+U jumps to the most recent unread.
|
||
|
||
The in-app browser has a scriptable API ported from [agent-browser](https://github.com/vercel-labs/agent-browser). Agents can snapshot the accessibility tree, get element refs, click, fill forms, and evaluate JS. You can split a browser pane next to your terminal and have Claude Code interact with your dev server directly.
|
||
|
||
Everything is scriptable through the CLI and socket API — create workspaces/tabs, split panes, send keystrokes, open URLs in the browser.
|
||
|
||
## Keyboard Shortcuts
|
||
|
||
### Workspaces
|
||
|
||
| Shortcut | Action |
|
||
|----------|--------|
|
||
| ⌘ N | New workspace |
|
||
| ⌘ 1–8 | Jump to workspace 1–8 |
|
||
| ⌘ 9 | Jump to last workspace |
|
||
| ⌃ ⌘ ] | Next workspace |
|
||
| ⌃ ⌘ [ | Previous workspace |
|
||
| ⌘ ⇧ W | Close workspace |
|
||
| ⌘ ⇧ R | Rename workspace |
|
||
| ⌘ B | Toggle sidebar |
|
||
|
||
### Surfaces
|
||
|
||
| Shortcut | Action |
|
||
|----------|--------|
|
||
| ⌘ T | New surface |
|
||
| ⌘ ⇧ ] | Next surface |
|
||
| ⌘ ⇧ [ | Previous surface |
|
||
| ⌃ Tab | Next surface |
|
||
| ⌃ ⇧ Tab | Previous surface |
|
||
| ⌃ 1–8 | Jump to surface 1–8 |
|
||
| ⌃ 9 | Jump to last surface |
|
||
| ⌘ W | Close surface |
|
||
|
||
### Split Panes
|
||
|
||
| Shortcut | Action |
|
||
|----------|--------|
|
||
| ⌘ D | Split right |
|
||
| ⌘ ⇧ D | Split down |
|
||
| ⌥ ⌘ ← → ↑ ↓ | Focus pane directionally |
|
||
| ⌘ ⇧ H | Flash focused panel |
|
||
|
||
### Browser
|
||
|
||
Browser developer-tool shortcuts follow Safari defaults and are customizable in `Settings → Keyboard Shortcuts`.
|
||
|
||
| Shortcut | Action |
|
||
|----------|--------|
|
||
| ⌘ ⇧ L | Open browser in split |
|
||
| ⌘ L | Focus address bar |
|
||
| ⌘ [ | Back |
|
||
| ⌘ ] | Forward |
|
||
| ⌘ R | Reload page |
|
||
| ⌥ ⌘ I | Toggle Developer Tools (Safari default) |
|
||
| ⌥ ⌘ C | Show JavaScript Console (Safari default) |
|
||
|
||
### Notifications
|
||
|
||
| Shortcut | Action |
|
||
|----------|--------|
|
||
| ⌘ I | Show notifications panel |
|
||
| ⌘ ⇧ U | Jump to latest unread |
|
||
|
||
### Find
|
||
|
||
| Shortcut | Action |
|
||
|----------|--------|
|
||
| ⌘ F | Find |
|
||
| ⌘ G / ⌘ ⇧ G | Find next / previous |
|
||
| ⌘ ⇧ F | Hide find bar |
|
||
| ⌘ E | Use selection for find |
|
||
|
||
### Terminal
|
||
|
||
| Shortcut | Action |
|
||
|----------|--------|
|
||
| ⌘ K | Clear scrollback |
|
||
| ⌘ C | Copy (with selection) |
|
||
| ⌘ V | Paste |
|
||
| ⌘ + / ⌘ - | Increase / decrease font size |
|
||
| ⌘ 0 | Reset font size |
|
||
|
||
### Window
|
||
|
||
| Shortcut | Action |
|
||
|----------|--------|
|
||
| ⌘ ⇧ N | New window |
|
||
| ⌘ , | Settings |
|
||
| ⌘ ⇧ , | Reload configuration |
|
||
| ⌘ Q | Quit |
|
||
|
||
## Nightly Builds
|
||
|
||
[Download cmux NIGHTLY](https://github.com/manaflow-ai/cmux/releases/download/nightly/cmux-nightly-macos.dmg)
|
||
|
||
cmux NIGHTLY is a separate app with its own bundle ID, so it runs alongside the stable version. Built automatically from the latest `main` commit and auto-updates via its own Sparkle feed.
|
||
|
||
## Star History
|
||
|
||
<a href="https://star-history.com/#manaflow-ai/cmux&Date">
|
||
<picture>
|
||
<source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=manaflow-ai/cmux&type=Date&theme=dark" />
|
||
<source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=manaflow-ai/cmux&type=Date" />
|
||
<img alt="Star History Chart" src="https://api.star-history.com/svg?repos=manaflow-ai/cmux&type=Date" width="600" />
|
||
</picture>
|
||
</a>
|
||
|
||
## Community
|
||
|
||
- [Discord](https://discord.gg/xsgFEVrWCZ)
|
||
- [GitHub](https://github.com/manaflow-ai/cmux)
|
||
- [X / Twitter](https://twitter.com/manaflowai)
|
||
- [YouTube](https://www.youtube.com/channel/UCAa89_j-TWkrXfk9A3CbASw)
|
||
- [LinkedIn](https://www.linkedin.com/company/manaflow-ai/)
|
||
|
||
## License
|
||
|
||
This project is licensed under the GNU Affero General Public License v3.0 or later (`AGPL-3.0-or-later`).
|
||
|
||
See `LICENSE` for the full text.
|