import type { Metadata } from "next"; import { CodeBlock } from "../../components/code-block"; import { Callout } from "../../components/callout"; import { DownloadButton } from "../../components/download-button"; export const metadata: Metadata = { title: "Getting Started", description: "Install cmux, the native macOS terminal for AI coding agents. Homebrew, DMG download, CLI setup, and auto-updates via Sparkle.", }; export default function GettingStartedPage() { return ( <>

Getting Started

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.

Install

DMG (recommended)

Open the .dmg and drag cmux to your Applications folder. cmux auto-updates via Sparkle, so you only need to download once.

Homebrew

{`brew tap manaflow-ai/cmux brew install --cask cmux`}

To update later:

{`brew upgrade --cask cmux`} On first launch, macOS may ask you to confirm opening an app from an identified developer. Click Open to proceed.

Verify installation

Open cmux and you should see:

CLI setup

cmux includes a command-line tool for automation. Inside cmux terminals it works automatically. To use the CLI from outside cmux, create a symlink:

{`sudo ln -sf "/Applications/cmux.app/Contents/Resources/bin/cmux" /usr/local/bin/cmux`}

Then you can run commands like:

{`cmux list-workspaces cmux notify --title "Build Complete" --body "Your build finished"`}

Auto-updates

cmux checks for updates automatically via Sparkle. When an update is available you'll see an update pill in the titlebar. You can also check manually via cmux → Check for Updates in the menu bar.

Session restore (current behavior)

After relaunch, cmux restores layout and metadata only:

cmux does not restore live process state yet. Active terminal app sessions such as Claude Code, tmux, and vim are not resumed after app restart.

Requirements

); }