cmuxcmux/docs

入门指南

cmux 是一个基于 Ghostty 构建的轻量级原生 macOS 终端，用于管理多个 AI coding agent。支持垂直标签页、通知面板和基于 socket 的控制 API。

安装

DMG（推荐）

下载 Mac 版

打开 .dmg 文件，将 cmux 拖到「应用程序」文件夹。cmux 通过 Sparkle 自动更新，只需下载一次。

Homebrew

brew tap manaflow-ai/cmux
brew install --cask cmux

后续更新：

brew upgrade --cask cmux
首次启动时，macOS 可能会要求确认打开来自已识别开发者的应用。点击打开即可继续。

验证安装

打开 cmux，你应该会看到：

  • 左侧有垂直标签页侧边栏的终端窗口
  • 一个已打开的初始工作区
  • 由 Ghostty 驱动的终端已就绪，可以输入

CLI 设置

cmux 包含一个用于自动化的命令行工具。在 cmux 终端内会自动生效。如果要在 cmux 外部使用 CLI，请创建符号链接：

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

之后你就可以运行以下命令：

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

自动更新

cmux 通过 Sparkle 自动检查更新。有可用更新时，标题栏会显示更新提示。你也可以通过菜单栏的 cmux > Check for Updates 手动检查。

会话恢复（当前行为）

重新启动后，cmux 仅恢复布局和元数据：

  • 窗口、工作区和面板布局
  • 工作目录
  • 终端回滚缓冲区（尽力恢复）
  • 浏览器 URL 和导航历史
cmux 暂不支持恢复实时进程状态。活跃的终端应用会话（如 Claude Code、tmux、vim）在应用重启后不会恢复。

系统要求

  • macOS 14.0 或更高版本
  • Apple Silicon 或 Intel Mac