#技能
cmux 随附的技能会教编码代理使用 cmux CLI 控制、浏览器界面、Markdown 面板、调试窗口和发布流程。
#安装
运行 skills.sh,将仓库中的技能安装到你的 Codex 技能目录。
# Install all cmux skills
npx skills add manaflow-ai/cmux -g -y
# Or install just diagnostics
npx skills add manaflow-ai/cmux --skill cmux-diagnostics -g -ycurl -fsSL https://raw.githubusercontent.com/manaflow-ai/cmux/main/skills.sh | bash~/.codex/skills,当设置了 CODEX_HOME 时会安装到 $CODEX_HOME/skills。如果你的代理从其他目录读取技能,请传入 --dest。#从 checkout 安装
在克隆的 cmux checkout 中,脚本会使用本地 skills 目录。
./skills.sh
./skills.sh --list
./skills.sh --skill cmux --skill cmux-browser
./skills.sh --dest ~/.codex/skills
./skills.sh --dry-run当脚本从 GitHub 下载时,使用 --ref 可以从指定 branch、tag 或 commit 安装。
curl -fsSL https://raw.githubusercontent.com/manaflow-ai/cmux/main/skills.sh | bash -s -- --ref main#内置技能
每个技能都有一个 SKILL.md 文件、可选参考资料,以及 agents/openai.yaml 下的 OpenAI 元数据文件。
| 技能 | 用途 | 常用命令 |
|---|---|---|
cmux Coreskills/cmux/SKILL.md | 通过 cmux CLI 控制窗口、工作区、面板、界面、焦点、移动、重排和路由。 当代理需要在多面板 cmux 布局中进行确定性的放置或导航时使用。 | cmux identify --json |
cmux Workspaceskills/cmux-workspace/SKILL.md | Keeps automation scoped to the current caller workspace, caller surface, panes, sidebar metadata, and socket context. Use it when an agent should add panes, send input, inspect state, or open helper surfaces without disrupting another workspace. | cmux current-workspace --json |
cmux Settingsskills/cmux-settings/SKILL.md | Inspects, edits, validates, and opens ~/.config/cmux/cmux.json with a bundled helper script. Use it when changing appearance, sidebar, notification, browser, automation, or shortcut settings by JSON path. | skills/cmux-settings/scripts/cmux-settings list-supported |
cmux Customizationskills/cmux-customization/SKILL.md | Customizes cmux.json actions, plus-button behavior, tab bar buttons, workspace layouts, Dock controls, Feed hooks, sidebar settings, Command Palette entries, shortcuts, and Ghostty-owned terminal preferences. Use it to make cmux open a user's worktrees, multiple checkouts, SSH sessions, dev tools, or project layout from the exact UI entrypoints they want. | cmux reload-config |
cmux Diagnosticsskills/cmux-diagnostics/SKILL.md | Runs support-safe checks for cmux CLI health, socket access, hooks, session restore, settings, and agent binaries. Use it when notifications, hooks, restore, or automation are not behaving as expected. | skills/cmux-diagnostics/scripts/cmux-diagnostics |
cmux Browserskills/cmux-browser/SKILL.md | 使用 snapshot 引用、DOM 操作、等待、截图和会话状态来自动化 cmux webview 界面。 用于应在 cmux 内运行的浏览器任务,而不是使用单独的浏览器自动化工具。 | cmux browser surface:2 snapshot --interactive |
cmux Markdown Viewerskills/cmux-markdown/SKILL.md | 在带实时重载的格式化 cmux 面板中打开 Markdown 文件。 用于在工作时把计划、文档、笔记和任务列表显示在终端旁边。 | cmux markdown open plan.md |
#What the skills cover
The top-level SKILL.md files stay short. Deeper command details live in references, scripts, and templates next to each skill.
| 技能 | Scope | Reference coverage |
|---|---|---|
cmux Corecmux | Topology control for windows, workspaces, panes, surfaces, focus, moves, reorders, split-off flows, and attention flashes. | Handle syntax, caller targeting, window and workspace lifecycle, pane and surface routing, trigger flash, and health checks. |
cmux Workspacecmux-workspace | Current-workspace automation rules for caller context, additive panes, helper surfaces, sidebar metadata, input, and socket selection. | Workspace command reference covering context, windows, workspaces, panes, surfaces, input, sidebar state, notifications, docs, and tagged reloads. |
cmux Settingscmux-settings | cmux.json settings reads and writes, key lookup, JSONC parsing, safe atomic updates, validation, editor opening, and shortcut binding edits. | Generated settings key list, shortcut action ids, schema URL, supported path detection, and the bundled cmux-settings helper. |
cmux Customizationcmux-customization | End-user customization across cmux.json settings, actions, commands, workspace layouts, plus-button click and right-click menus, surface tab bar buttons, Dock controls, Feed and notification hooks, sidebar metadata, Command Palette entries, shortcuts, and Ghostty config boundaries. | Config-surface selection, what can be customized, global versus project-local scope, action examples, plus-button wiring, tab bar button examples, Dock examples, Feed hooks, workspace layout examples, reload steps, validation rules, and safety constraints. |
cmux Diagnosticscmux-diagnostics | Read-only health checks for CLI reachability, socket access, cmux environment, settings validation, hook installation markers, session stores, auto-resume settings, and supported agent binaries. | Bundled support-safe diagnostic script, hook setup commands, session restore interpretation, notification checks, and rules for redacting sensitive files. |
cmux Browsercmux-browser | Browser automation inside cmux webview surfaces, including navigation, DOM actions, waits, state capture, screenshots, and snapshots. | Command mapping, snapshot ref lifecycle, authentication, session persistence, video status, proxy behavior, and reusable automation templates. |
cmux Markdown Viewercmux-markdown | Formatted markdown panels that live beside terminals and reload as files change. | Command syntax, routing options, live reload behavior, atomic file replacement, and markdown rendering coverage. |
#Customization examples library
These are reusable workflow patterns that a user can ask an agent to apply with cmux Customization.
| Example | Customizes | Good for |
|---|---|---|
Worktree agentsworktree-agents | Plus-button click, plus-button right-click menu, Command Palette, workspace layout | Opening a dedicated worktree or checkout with paired Codex, Claude, SSH, or helper terminals. |
Full-stack devfull-stack-dev | Workspace command, browser preview, Dock controls | Starting frontend, backend, tests, logs, and preview panes in the same repeatable layout. |
SSH devboxssh-devbox | Workspace command, remote terminal, browser surface | Connecting to a remote environment while keeping local previews, notes, and navigation in cmux. |
Review PRreview-pr | Workspace command, browser surface, markdown or terminal notes | Opening GitHub status, the pull request, and review notes in a single workspace. |
Docs workspacedocs-workspace | Workspace command, markdown panel, browser preview | Editing documentation with the rendered page, local dev server, and source notes visible. |
CI watchci-watch | Dock controls, Feed TUI, notification hooks | Watching GitHub Actions, CircleCI, release monitors, and agent hook events without losing the main workspace. |
Quick agent buttonsquick-agent-buttons | Surface tab bar buttons, actions, Command Palette entries | Adding one-click Codex, Claude, or custom-agent launchers while keeping built-in tab buttons visible. |
skills/cmux-customization/references/examples.md. Agents load that file only when an examples-library pattern is needed.Use $cmux-customization to set up the worktree-agents example.
Use $cmux-customization to create a project-local full-stack-dev layout with Dock controls.
Use $cmux-customization to add quick-agent-buttons for Codex and Claude.#帮助菜单
macOS Help 菜单会镜像这个文档侧边栏,并包含 Skills。在 Help 中使用 Skills 项即可从应用打开此页面。
#技能结构
保持主 SKILL.md 简洁。更详细的命令表、脚本和可复用模板应放在技能旁边。
skills/<name>/SKILL.md
skills/<name>/agents/openai.yaml
skills/<name>/references/*.md
skills/<name>/scripts/*
skills/<name>/templates/*agents/openai.yaml,这样安装器就能显示清晰名称、简短说明和默认 prompt。#Suggested future skills
These are good candidates if the skill set grows beyond the current installed list.
| Skill idea | Use case | Why it helps |
|---|---|---|
cmux SSHcmux-ssh | Drive remote workspaces, SSH URL launches, browser routing through remote networks, and reconnect behavior. | Remote sessions are a major cmux surface with behavior that differs from local terminal workflows. |
cmux Cloud VMcmux-cloud-vm | Operate Cloud VM create, attach, exec, SSH endpoint, billing, and provider troubleshooting flows. | Cloud VM work crosses the web app, database, provider APIs, and smoke tests. |
cmux Vaultcmux-vault | Manage vault-backed agent configuration, credentials, and restore behavior without leaking secrets into prompts. | Vault workflows need stricter handling than normal settings because they affect secrets and agent startup. |