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 ( <>
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.
Open the .dmg and drag cmux to your Applications folder.
cmux auto-updates via Sparkle, so you only need to download once.
To update later:
Open cmux and you should see:
cmux includes a command-line tool for automation. Inside cmux terminals it works automatically. To use the CLI from outside cmux, create a symlink:
Then you can run commands like:
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.
After relaunch, cmux restores layout and metadata only: