# 入门指南

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

## 安装

### DMG（推荐）

[下载 Mac 版](https://cmux.com/zh-CN/download/confirmation?dl=1)

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

### Homebrew

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

后续更新：

```
brew upgrade --cask cmux
```

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

## 验证安装

打开 cmux，你应该会看到：

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

## CLI 设置

cmux 包含一个用于自动化的命令行工具。在 cmux 终端内会自动生效。如果要在其他终端中使用，请打开命令面板（⌘⇧P）并运行**Shell 命令：将 'cmux' 安装到 PATH**。它会把内置的 CLI 链接到 /usr/local/bin，如果该目录需要权限，会要求输入管理员密码。

也可以自己创建符号链接：

```
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 设为默认终端

如果希望从访达打开的 ssh:// 链接和 shell 脚本在 cmux 而不是“终端”中打开，请在菜单栏中选择**cmux > 将 cmux 设为默认终端**，或在命令面板中运行**将 cmux 设为默认终端**。

## 自动更新

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

## 会话恢复（当前行为）

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

cmux 暂不支持恢复实时进程状态。活跃的终端应用会话（如 Claude Code、tmux、vim）在应用重启后不会恢复。

See the [session restore guide](https://cmux.com/zh-CN/docs/session-restore) for agent hook setup and the supported resume matrix.

## 系统要求

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

Canonical: https://cmux.com/zh-CN/docs/getting-started

Documentation index: https://cmux.com/llms.txt