Dokumentacja API

cmux zapewnia zarówno narzędzie CLI jak i Unix socket do programowej kontroli. Każde polecenie jest dostępne przez oba interfejsy.

Socket

Build	Ścieżka
Release	`/tmp/cmux.sock`
Debug	`/tmp/cmux-debug.sock`
Tagowany build debugowy	`/tmp/cmux-debug-<tag>.sock`

Nadpisz zmienną środowiskową CMUX_SOCKET_PATH. Wyślij jedno żądanie JSON zakończone nową linią na wywołanie:

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

Żądania JSON na socket muszą używać method i params. Starsze payloady JSON v1 takie jak {"command":"..."} nie są obsługiwane.

Tryby dostępu

Tryb	Opis	Jak włączyć
Off	Socket wyłączony	Interfejs ustawień lub CMUX_SOCKET_MODE=off
cmux processes only	Tylko procesy uruchomione w terminalach cmux mogą się połączyć.	Domyślny tryb w interfejsie ustawień
allowAll	Pozwól dowolnemu lokalnemu procesowi na połączenie (bez sprawdzania pochodzenia).	Tylko nadpisanie zmiennej środowiskowej: CMUX_SOCKET_MODE=allowAll

Na współdzielonych maszynach używaj trybu Wyłączony lub Tylko procesy cmux.

Opcje CLI

Flaga	Opis
`--socket PATH`	Niestandardowa ścieżka socketa
`--json`	Wyjście w formacie JSON
`--window ID`	Celuj w konkretne okno
`--workspace ID`	Celuj w konkretny workspace
`--surface ID`	Celuj w konkretny surface
`--id-format refs\|uuids\|both`	Kontroluj format identyfikatorów w wyjściu JSON

Polecenia workspace

list-workspaces

Wyświetl wszystkie otwarte workspace'y.

CLI

cmux list-workspaces
cmux list-workspaces --json

Socket

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

new-workspace

Utwórz nowy workspace.

CLI

cmux new-workspace

Socket

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

select-workspace

Przełącz na konkretny workspace.

CLI

cmux select-workspace --workspace <id>

Socket

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

current-workspace

Pobierz aktualnie aktywny workspace.

CLI

cmux current-workspace
cmux current-workspace --json

Socket

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

close-workspace

Zamknij workspace.

CLI

cmux close-workspace --workspace <id>

Socket

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

Polecenia podziału

new-split

Utwórz nowy dzielony panel. Kierunki: 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

Wyświetl wszystkie surface'y w bieżącym workspace.

CLI

cmux list-surfaces
cmux list-surfaces --json

Socket

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

focus-surface

Ustaw fokus na konkretnym surface.

CLI

cmux focus-surface --surface <id>

Socket

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

Polecenia wejścia

send

Wyślij tekst do fokusowanego terminala.

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

Wyślij naciśnięcie klawisza. Klawisze: 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

Wyślij tekst do konkretnego surface'a.

CLI

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

Socket

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

send-key-surface

Wyślij naciśnięcie klawisza do konkretnego surface'a.

CLI

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

Socket

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

Polecenia powiadomień

notify

Wyślij powiadomienie.

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

Wyświetl wszystkie powiadomienia.

CLI

cmux list-notifications
cmux list-notifications --json

Socket

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

clear-notifications

Wyczyść wszystkie powiadomienia.

CLI

cmux clear-notifications

Socket

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

Polecenia metadanych paska bocznego

Ustaw wskaźniki statusu, paski postępu i wpisy logów w pasku bocznym dla dowolnego workspace'a. Przydatne do skryptów budowania, integracji CI i agentów kodowania AI którzy chcą wyświetlić stan na pierwszy rzut oka.

set-status

Ustaw wskaźnik statusu w pasku bocznym. Użyj unikalnego klucza żeby różne narzędzia mogły zarządzać własnymi wpisami.

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

Usuń wpis statusu z paska bocznego po kluczu.

CLI

cmux clear-status build

Socket

clear_status build --tab=<workspace-uuid>

list-status

Wyświetl wszystkie wpisy statusu paska bocznego dla workspace'a.

CLI

cmux list-status

Socket

list_status --tab=<workspace-uuid>

set-progress

Ustaw pasek postępu w pasku bocznym (0.0 do 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

Wyczyść pasek postępu paska bocznego.

CLI

cmux clear-progress

Socket

clear_progress --tab=<workspace-uuid>

log

Dodaj wpis logu do paska bocznego. Poziomy: 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

Wyczyść wszystkie wpisy logów paska bocznego.

CLI

cmux clear-log

Socket

clear_log --tab=<workspace-uuid>

list-log

Wyświetl wpisy logów paska bocznego.

CLI

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

Socket

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

sidebar-state

Wyświetl wszystkie metadane paska bocznego (cwd, gałąź git, porty, status, postęp, logi).

CLI

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

Socket

sidebar_state --tab=<workspace-uuid>

Polecenia narzędziowe

ping

Sprawdź czy cmux działa i odpowiada.

CLI

cmux ping

Socket

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

capabilities

Wyświetl dostępne metody socketa i aktualny tryb dostępu.

CLI

cmux capabilities
cmux capabilities --json

Socket

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

identify

Pokaż kontekst fokusowanego okna/workspace'a/panelu/surface'a.

CLI

cmux identify
cmux identify --json

Socket

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

Zmienne środowiskowe

Zmienna	Opis
`CMUX_SOCKET_PATH`	Nadpisz ścieżkę socketa używaną przez CLI i integracje
`CMUX_SOCKET_ENABLE`	Wymuś włączenie/wyłączenie socketa (1/0, true/false, on/off)
`CMUX_SOCKET_MODE`	Nadpisz tryb dostępu (cmuxOnly, allowAll, off). Akceptuje też cmux-only/cmux_only i allow-all/allow_all
`CMUX_WORKSPACE_ID`	Ustawiane automatycznie: ID bieżącego workspace'a
`CMUX_SURFACE_ID`	Ustawiane automatycznie: ID bieżącego surface'a
`TERM_PROGRAM`	Ustawione na ghostty
`TERM`	Ustawione na xterm-ghostty

Starsze wartości CMUX_SOCKET_MODE full i notifications są nadal akceptowane dla kompatybilności.

Wykrywanie 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"

Przykłady

Klient 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"
))

Skrypt powłoki

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"}}'

Skrypt budowania z powiadomieniem

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