Справочник API

cmux предоставляет и CLI-утилиту, и Unix socket для программного управления. Каждая команда доступна через оба интерфейса.

Socket

Сборка	Путь
Release	`/tmp/cmux.sock`
Debug	`/tmp/cmux-debug.sock`
Тегированная debug-сборка	`/tmp/cmux-debug-<tag>.sock`

Переопределить переменной окружения CMUX_SOCKET_PATH. Отправляй один JSON-запрос с переводом строки за вызов:

{"id":"req-1","method":"workspace.list","params":{}}
// Response:
{"id":"req-1","ok":true,"result":{"workspaces":[...]}}

JSON socket-запросы должны использовать method и params. Устаревшие v1 JSON-форматы типа {"command":"..."} не поддерживаются.

Режимы доступа

Режим	Описание	Как включить
Off	Socket отключён	Интерфейс настроек или CMUX_SOCKET_MODE=off
cmux processes only	Только процессы, запущенные внутри терминалов cmux, могут подключаться.	Режим по умолчанию в интерфейсе настроек
allowAll	Любой локальный процесс может подключиться (без проверки происхождения).	Только через переменную окружения: CMUX_SOCKET_MODE=allowAll

На общих машинах используй Выключен или Только процессы cmux.

Опции CLI

Флаг	Описание
`--socket PATH`	Пользовательский путь к сокету
`--json`	Вывод в формате JSON
`--window ID`	Указать конкретное окно
`--workspace ID`	Указать конкретное рабочее пространство
`--surface ID`	Указать конкретную поверхность
`--id-format refs\|uuids\|both`	Формат идентификаторов в JSON-выводе

Команды рабочих пространств

list-workspaces

Список всех открытых рабочих пространств.

CLI

cmux list-workspaces
cmux list-workspaces --json

Socket

{"id":"ws-list","method":"workspace.list","params":{}}

new-workspace

Создать новое рабочее пространство.

CLI

cmux new-workspace

Socket

{"id":"ws-new","method":"workspace.create","params":{}}

select-workspace

Переключиться на конкретное рабочее пространство.

CLI

cmux select-workspace --workspace <id>

Socket

{"id":"ws-select","method":"workspace.select","params":{"workspace_id":"<id>"}}

current-workspace

Получить текущее активное рабочее пространство.

CLI

cmux current-workspace
cmux current-workspace --json

Socket

{"id":"ws-current","method":"workspace.current","params":{}}

close-workspace

Закрыть рабочее пространство.

CLI

cmux close-workspace --workspace <id>

Socket

{"id":"ws-close","method":"workspace.close","params":{"workspace_id":"<id>"}}

Команды разделения

new-split

Создать новую разделённую панель. Направления: left, right, up, down.

CLI

cmux new-split right
cmux new-split down

Socket

{"id":"split-new","method":"surface.split","params":{"direction":"right"}}

list-surfaces

Список всех поверхностей в текущем рабочем пространстве.

CLI

cmux list-surfaces
cmux list-surfaces --json

Socket

{"id":"surface-list","method":"surface.list","params":{}}

focus-surface

Сфокусировать конкретную поверхность.

CLI

cmux focus-surface --surface <id>

Socket

{"id":"surface-focus","method":"surface.focus","params":{"surface_id":"<id>"}}

Команды ввода

send

Отправить текст в сфокусированный терминал.

CLI

cmux send "echo hello"
cmux send "ls -la\n"

Socket

{"id":"send-text","method":"surface.send_text","params":{"text":"echo hello\n"}}

send-key

Отправить нажатие клавиши. Клавиши: enter, tab, escape, backspace, delete, up, down, left, right.

CLI

cmux send-key enter

Socket

{"id":"send-key","method":"surface.send_key","params":{"key":"enter"}}

send-surface

Отправить текст в конкретную поверхность.

CLI

cmux send-surface --surface <id> "command"

Socket

{"id":"send-surface","method":"surface.send_text","params":{"surface_id":"<id>","text":"command"}}

send-key-surface

Отправить нажатие клавиши в конкретную поверхность.

CLI

cmux send-key-surface --surface <id> enter

Socket

{"id":"send-key-surface","method":"surface.send_key","params":{"surface_id":"<id>","key":"enter"}}

Команды уведомлений

notify

Отправить уведомление.

CLI

cmux notify --title "Title" --body "Body"
cmux notify --title "T" --subtitle "S" --body "B"

Socket

{"id":"notify","method":"notification.create","params":{"title":"Title","subtitle":"S","body":"Body"}}

list-notifications

Список всех уведомлений.

CLI

cmux list-notifications
cmux list-notifications --json

Socket

{"id":"notif-list","method":"notification.list","params":{}}

clear-notifications

Очистить все уведомления.

CLI

cmux clear-notifications

Socket

{"id":"notif-clear","method":"notification.clear","params":{}}

Команды метаданных боковой панели

Устанавливай значки статуса, прогресс-бары и записи лога на боковой панели для любого рабочего пространства. Полезно для скриптов сборки, CI-интеграций и AI-агентов, которые хотят показать состояние на одном взгляде.

set-status

Установить значок статуса на боковой панели. Используй уникальный ключ, чтобы разные инструменты могли управлять своими записями.

CLI

cmux set-status build "compiling" --icon hammer --color "#ff9500"
cmux set-status deploy "v1.2.3" --workspace workspace:2

Socket

set_status build compiling --icon=hammer --color=#ff9500 --tab=<workspace-uuid>

clear-status

Удалить запись статуса боковой панели по ключу.

CLI

cmux clear-status build

Socket

clear_status build --tab=<workspace-uuid>

list-status

Список всех записей статуса боковой панели для рабочего пространства.

CLI

cmux list-status

Socket

list_status --tab=<workspace-uuid>

set-progress

Установить прогресс-бар на боковой панели (0.0 до 1.0).

CLI

cmux set-progress 0.5 --label "Building..."
cmux set-progress 1.0 --label "Done"

Socket

set_progress 0.5 --label=Building... --tab=<workspace-uuid>

clear-progress

Очистить прогресс-бар боковой панели.

CLI

cmux clear-progress

Socket

clear_progress --tab=<workspace-uuid>

log

Добавить запись лога на боковую панель. Уровни: info, progress, success, warning, error.

CLI

cmux log "Build started"
cmux log --level error --source build "Compilation failed"
cmux log --level success -- "All 42 tests passed"

Socket

log --level=error --source=build --tab=<workspace-uuid> -- Compilation failed

clear-log

Очистить все записи лога боковой панели.

CLI

cmux clear-log

Socket

clear_log --tab=<workspace-uuid>

list-log

Список записей лога боковой панели.

CLI

cmux list-log
cmux list-log --limit 5

Socket

list_log --limit=5 --tab=<workspace-uuid>

sidebar-state

Дамп всех метаданных боковой панели (cwd, ветка git, порты, статус, прогресс, логи).

CLI

cmux sidebar-state
cmux sidebar-state --workspace workspace:2

Socket

sidebar_state --tab=<workspace-uuid>

Служебные команды

ping

Проверить работает ли cmux и отвечает.

CLI

cmux ping

Socket

{"id":"ping","method":"system.ping","params":{}}
// Response: {"id":"ping","ok":true,"result":{"pong":true}}

capabilities

Список доступных методов сокета и текущего режима доступа.

CLI

cmux capabilities
cmux capabilities --json

Socket

{"id":"caps","method":"system.capabilities","params":{}}

identify

Показать контекст сфокусированного окна/рабочего пространства/панели/поверхности.

CLI

cmux identify
cmux identify --json

Socket

{"id":"identify","method":"system.identify","params":{}}

Переменные окружения

Переменная	Описание
`CMUX_SOCKET_PATH`	Переопределить путь к сокету для CLI и интеграций
`CMUX_SOCKET_ENABLE`	Принудительно включить/отключить сокет (1/0, true/false, on/off)
`CMUX_SOCKET_MODE`	Переопределить режим доступа (cmuxOnly, allowAll, off). Также принимает cmux-only/cmux_only и allow-all/allow_all
`CMUX_WORKSPACE_ID`	Устанавливается автоматически: ID текущего рабочего пространства
`CMUX_SURFACE_ID`	Устанавливается автоматически: ID текущей поверхности
`TERM_PROGRAM`	Установлен в ghostty
`TERM`	Установлен в xterm-ghostty

Устаревшие значения CMUX_SOCKET_MODE full и notifications всё ещё принимаются для совместимости.

Обнаружение cmux

bash

# Prefer explicit socket path if set
SOCK="${CMUX_SOCKET_PATH:-/tmp/cmux.sock}"
[ -S "$SOCK" ] && echo "Socket available"

# Check for the CLI
command -v cmux &>/dev/null && echo "cmux available"

# In cmux-managed terminals these are auto-set
[ -n "${CMUX_WORKSPACE_ID:-}" ] && [ -n "${CMUX_SURFACE_ID:-}" ] && echo "Inside cmux surface"

# Distinguish from regular Ghostty
[ "$TERM_PROGRAM" = "ghostty" ] && [ -n "${CMUX_WORKSPACE_ID:-}" ] && echo "In cmux"

Примеры

Python-клиент

python

import json
import os
import socket

SOCKET_PATH = os.environ.get("CMUX_SOCKET_PATH", "/tmp/cmux.sock")

def rpc(method, params=None, req_id=1):
    payload = {"id": req_id, "method": method, "params": params or {}}
    with socket.socket(socket.AF_UNIX, socket.SOCK_STREAM) as sock:
        sock.connect(SOCKET_PATH)
        sock.sendall(json.dumps(payload).encode("utf-8") + b"\n")
        return json.loads(sock.recv(65536).decode("utf-8"))

# List workspaces
print(rpc("workspace.list", req_id="ws"))

# Send notification
print(rpc(
    "notification.create",
    {"title": "Hello", "body": "From Python!"},
    req_id="notify"
))

Shell-скрипт

bash

#!/bin/bash
SOCK="${CMUX_SOCKET_PATH:-/tmp/cmux.sock}"

cmux_cmd() {
    printf "%s\n" "$1" | nc -U "$SOCK"
}

cmux_cmd '{"id":"ws","method":"workspace.list","params":{}}'
cmux_cmd '{"id":"notify","method":"notification.create","params":{"title":"Done","body":"Task complete"}}'

Скрипт сборки с уведомлением

bash

#!/bin/bash
npm run build
if [ $? -eq 0 ]; then
    cmux notify --title "✓ Build Success" --body "Ready to deploy"
else
    cmux notify --title "✗ Build Failed" --body "Check the logs"
fi