cmux-workspace

Source excerpt starting at line 1.

1# cmux Workspace Command Reference2 3Use these commands from a cmux terminal. Most commands infer the caller workspace from `CMUX_WORKSPACE_ID`, but explicit flags are safer for automation.4 5## Context6 7```bash8cmux identify --json9cmux --json --id-format both identify   # stable UUIDs plus human refs, for logs and handoffs10cmux current-workspace --json11cmux capabilities --json12cmux ping13```14 15## Windows and Workspaces16 17```bash18cmux list-windows19cmux current-window20cmux new-window21cmux focus-window --window window:222cmux close-window --window window:223 24cmux list-workspaces25cmux list-workspaces --json26cmux new-workspace --name "task" --cwd "$PWD"27cmux new-workspace --command "npm run dev"28cmux new-workspace --layout '{"root":{"type":"terminal"}}'29cmux current-workspace30cmux select-workspace --workspace workspace:231cmux rename-workspace --workspace workspace:2 -- "new name"32cmux close-workspace --workspace workspace:233cmux reorder-workspace --workspace workspace:4 --before workspace:234cmux move-workspace-to-window --workspace workspace:4 --window window:135```36 37## Panes and Surfaces38 39```bash40cmux list-panes --workspace "$CMUX_WORKSPACE_ID"41cmux list-pane-surfaces --workspace "$CMUX_WORKSPACE_ID" --pane pane:142cmux list-panels --workspace "$CMUX_WORKSPACE_ID"43cmux tree --workspace "$CMUX_WORKSPACE_ID"44 45cmux new-split right --workspace "$CMUX_WORKSPACE_ID"46cmux new-split down --workspace "$CMUX_WORKSPACE_ID" --surface "$CMUX_SURFACE_ID"47cmux new-split down --workspace "$CMUX_WORKSPACE_ID" --command "npm run dev"48cmux new-pane --workspace "$CMUX_WORKSPACE_ID" --type terminal --direction right49cmux new-pane --workspace "$CMUX_WORKSPACE_ID" --type terminal --direction right --command "tail -f logs/dev.log"50cmux new-pane --workspace "$CMUX_WORKSPACE_ID" --type browser --url http://localhost:300051cmux new-surface --workspace "$CMUX_WORKSPACE_ID" --type terminal --pane pane:152cmux new-surface --workspace "$CMUX_WORKSPACE_ID" --type terminal --pane pane:1 --working-directory "$PWD" --command "npm test"53cmux new-surface --workspace "$CMUX_WORKSPACE_ID" --type browser --pane pane:1 --url http://localhost:300054 55cmux focus-pane --workspace "$CMUX_WORKSPACE_ID" --pane pane:256cmux focus-panel --workspace "$CMUX_WORKSPACE_ID" --panel surface:357cmux close-surface --workspace "$CMUX_WORKSPACE_ID" --surface surface:358cmux move-surface --surface surface:7 --pane pane:2 --focus true59cmux reorder-surface --surface surface:7 --before surface:360cmux move-tab-to-new-workspace --surface surface:7 --title "browser"61```62 63`--command <text>` (also on `new-workspace`) types the text plus one Enter into the new terminal's interactive shell at spawn time, so no follow-up `send` or `send-key enter` is needed and the shell stays alive after the command exits. It is terminal-only (`--type browser|simulator|agent-session` rejects it), blank text is ignored, and `new-workspace --layout` ignores it.64 65## Input66 67```bash68cmux send "echo hello\n"69cmux send-key enter70cmux send --surface "$CMUX_SURFACE_ID" "git status\n"71cmux send-key --surface "$CMUX_SURFACE_ID" enter72cmux read-screen --surface "$CMUX_SURFACE_ID"73```74 75## Sidebar Metadata76 77```bash78cmux set-status build "running" --workspace "$CMUX_WORKSPACE_ID" --icon hammer --color "#ff9500"79cmux clear-status build --workspace "$CMUX_WORKSPACE_ID"80cmux list-status --workspace "$CMUX_WORKSPACE_ID"81cmux set-progress 0.5 --workspace "$CMUX_WORKSPACE_ID" --label "Building"82cmux clear-progress --workspace "$CMUX_WORKSPACE_ID"83cmux log --workspace "$CMUX_WORKSPACE_ID" --level info -- "Build started"84cmux list-log --workspace "$CMUX_WORKSPACE_ID" --limit 2085cmux clear-log --workspace "$CMUX_WORKSPACE_ID"86cmux sidebar-state --workspace "$CMUX_WORKSPACE_ID" --json87```88 89## Notifications and Attention90 91```bash92notification_id="$(cmux notify --title "Done" --body "Task complete" --id-format uuids | awk '$1 == "OK" {print $2}')"93cmux dismiss-notification --id "$notification_id"94cmux notify --clear95cmux list-notifications --json96cmux clear-notifications --workspace "$CMUX_WORKSPACE_ID" --surface "$CMUX_SURFACE_ID"97cmux trigger-flash --workspace "$CMUX_WORKSPACE_ID" --surface "$CMUX_SURFACE_ID"98cmux surface-health --workspace "$CMUX_WORKSPACE_ID" --json99```100 101## Config and Docs102 103```bash104cmux docs api105cmux docs browser106cmux docs settings107cmux settings path108cmux settings cmux-json109cmux settings shortcuts110cmux reload-config111```112