cmux/docs-site/content/docs/index.mdx
Lawrence Chen f36525f5f1 Add documentation site and Homebrew installation
- Add Fumadocs-based docs site (docs-site/)
- Document all features: tabs, notifications, splits, socket API, CLI
- Add Claude Code hooks guide with cmuxterm detection
- Update README with native macOS emphasis and brew install
- Add homebrew-cmuxterm to .gitignore (has its own repo)
2026-01-29 04:41:39 -08:00

57 lines
2 KiB
Text

---
title: Introduction
description: cmuxterm - A lightweight native macOS terminal with vertical tabs and notifications for AI coding agents
---
# cmuxterm
cmuxterm 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 cmuxterm?
- **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
cmuxterm 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/cmuxterm
brew install --cask cmuxterm
```
Or [download the DMG](https://github.com/manaflow-ai/cmuxterm/releases/latest/download/cmuxterm-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