9817d131f8
* Rename cmuxterm to cmux across entire codebase - Rename GitHub repos: manaflow-ai/cmuxterm -> manaflow-ai/cmux, manaflow-ai/homebrew-cmuxterm -> manaflow-ai/homebrew-cmux - Rename bundle IDs: com.cmuxterm.app -> com.cmux.app - Rename CLI: CLI/cmuxterm.swift -> CLI/cmux.swift - Rename homebrew submodule: homebrew-cmuxterm -> homebrew-cmux - Update all socket paths: /tmp/cmuxterm*.sock -> /tmp/cmux*.sock - Update all GitHub URLs, DMG names, Sparkle URLs - Update all source files, scripts, tests, docs, CI workflows * Bump version to 1.23.0
57 lines
2 KiB
Text
57 lines
2 KiB
Text
---
|
|
title: Introduction
|
|
description: cmux - A lightweight native macOS terminal with vertical tabs and notifications for AI coding agents
|
|
---
|
|
|
|
# cmux
|
|
|
|
cmux is a lightweight, native macOS terminal built on Ghostty for managing multiple AI coding agents. It features vertical tabs, a notification panel, and a socket-based control API.
|
|
|
|
## Why cmux?
|
|
|
|
- **Native macOS app** - Built with Swift and AppKit, not Electron. Fast startup, low memory usage, and native look and feel.
|
|
- **Lightweight** - Small binary, minimal resource footprint. No bundled browser engine.
|
|
- **GPU-accelerated** - Powered by libghostty for buttery smooth rendering.
|
|
|
|
When running AI coding agents like Claude Code, Codex, or similar tools, you need to:
|
|
|
|
- **Manage multiple terminal sessions** - Each agent runs in its own terminal
|
|
- **Know when agents need attention** - Agents waiting for input should notify you
|
|
- **Automate terminal control** - Programmatically create tabs, send input, and more
|
|
|
|
cmux solves these with:
|
|
|
|
- **Vertical sidebar tabs** - All terminals visible at a glance
|
|
- **OSC 99/777 notifications** - Desktop alerts when agents need you
|
|
- **Unix socket API** - Full programmatic control for automation
|
|
|
|
## Quick Start
|
|
|
|
```bash
|
|
brew tap manaflow-ai/cmux
|
|
brew install --cask cmux
|
|
```
|
|
|
|
Or [download the DMG](https://github.com/manaflow-ai/cmux/releases/latest/download/cmux-macos.dmg) directly.
|
|
|
|
## Key Features
|
|
|
|
<Cards>
|
|
<Card title="Vertical Tabs" href="/tabs">
|
|
All terminals in a resizable sidebar with keyboard navigation
|
|
</Card>
|
|
<Card title="Notifications" href="/notifications">
|
|
Desktop alerts via OSC 99/777 sequences when agents need attention
|
|
</Card>
|
|
<Card title="Socket API" href="/socket-api">
|
|
Unix socket for programmatic control - create tabs, send input, and more
|
|
</Card>
|
|
<Card title="Claude Code Hooks" href="/claude-code-hooks">
|
|
Send notifications from Claude Code when tasks complete
|
|
</Card>
|
|
</Cards>
|
|
|
|
## Requirements
|
|
|
|
- macOS 13.0 or later
|
|
- Apple Silicon or Intel Mac
|