cmux

Source excerpt starting at line 1.

1---2name: cmux3description: End-user control of cmux topology and routing (windows, workspaces, panes/surfaces, focus, moves, reorder, identify, trigger flash). Use when automation needs deterministic placement and navigation in a multi-pane cmux layout.4---5 6# cmux Core Control7 8Non-browser cmux topology and routing.9 10- **Window**: top-level macOS cmux window.11- **Workspace**: tab-like group within a window.12- **Pane**: split container in a workspace.13- **Surface**: a tab within a pane (terminal or browser panel).14 15## Fast start16 17```bash18cmux identify --json                              # current caller context19cmux list-windows / list-workspaces / list-panes20cmux list-pane-surfaces --pane pane:121cmux new-workspace22cmux new-split right --panel pane:123cmux new-split down --command "npm run dev"       # new terminal runs the command in a live shell24cmux move-surface --surface surface:7 --pane pane:2 --focus true25cmux split-off --surface surface:7 right26cmux reorder-surface --surface surface:7 --before surface:327 28# workspace context-menu actions (color, description, rename, pin, ...)29cmux workspace-action --action set-color --color Blue30cmux workspace-action --action set-description --description "Ship checklist"31 32# attention cue33cmux trigger-flash --surface surface:734```35 36## Handle model37 38Output defaults to short refs (`window:N`, `workspace:N`, `pane:N`, `surface:N`). UUIDs are accepted as input; request UUID output only when needed with `--id-format uuids|both`.39 40## Initial command on new terminals41 42`new-workspace`, `new-split`, `new-pane`, and `new-surface` accept `--command <text>`. cmux starts the terminal's normal interactive shell and delivers the text plus one Enter at spawn time, so the command runs immediately and the shell stays alive after it exits. No follow-up `send` or `send-key enter` is needed, and the text is passed literally (quoting, `&&`, pipes, and `$VARS` are interpreted by the new shell). The flag is terminal-only: it is rejected with `--type browser|simulator|agent-session`, blank text is ignored, and `new-workspace --layout` ignores it because layout surfaces define their own commands. Details: [references/panes-surfaces.md](references/panes-surfaces.md).43 44## Settings45 46cmux-owned settings live in `~/.config/cmux/cmux.json`. `cmux docs settings` prints the docs URL, schema URL, raw GitHub resources, cmux.json paths, and reload command. `cmux settings`, `cmux settings cmux-json`, and `cmux settings shortcuts` open the UI.47 48`cmux reload-config` reloads both `cmux.json` and `~/.config/ghostty/config`, refreshing terminals in place with no app restart.49 50Terminal rendering (font, cursor style, theme, scrollback, `background-opacity`, `background-blur`) belongs in Ghostty config, not cmux settings. Everything else (app behavior, sidebar, notifications, browser behavior, automation, workspace colors, cmux-owned shortcuts) is cmux settings. Before editing, copy any existing `cmux.json` to a timestamped `.bak` next to it. Legacy `~/.config/cmux/settings.json` and `~/Library/Application Support/com.cmuxterm.app/settings.json` are read only as fallback for missing keys.51 52For a completed download, the CLI can inspect the bounded history owned by the53target browser surface without consuming a waiter:54 55```bash56cmux browser --surface <surface> download list57cmux browser --surface <surface> download list --limit 5 --json58```59 60Use the browser skill for the full response fields and wait/path compatibility61details.62 63## Deep-dive references64 65| Reference | When to Use |66|-----------|-------------|67| [references/handles-and-identify.md](references/handles-and-identify.md) | Handle syntax, self-identify, caller targeting |68| [references/windows-workspaces.md](references/windows-workspaces.md) | Window/workspace lifecycle, reorder/move, and context-menu actions (color, description, rename) |69| [references/panes-surfaces.md](references/panes-surfaces.md) | Splits, surfaces, move/reorder, focus routing |70| [references/trigger-flash-and-health.md](references/trigger-flash-and-health.md) | Flash cue and surface health checks |71| [../cmux-workspace/SKILL.md](../cmux-workspace/SKILL.md) | Current caller workspace rules and non-disruptive automation |72| [../cmux-settings/SKILL.md](../cmux-settings/SKILL.md) | Safe cmux.json settings edits and validation |73| [../cmux-browser/SKILL.md](../cmux-browser/SKILL.md) | Browser automation on surface-backed webviews |74| [../cmux-markdown/SKILL.md](../cmux-markdown/SKILL.md) | Markdown viewer panel with live file watching |75