API Referenca

cmux pruža i CLI alat i Unix socket za programsku kontrolu. Svaka komanda je dostupna kroz oba interfejsa.

Socket

Build	Putanja
Release	`/tmp/cmux.sock`
Debug	`/tmp/cmux-debug.sock`
Tagirani debug build	`/tmp/cmux-debug-<tag>.sock`

Zaobiđite sa CMUX_SOCKET_PATH varijablom okruženja. Pošaljite jedan JSON zahtjev terminiran novim redom po pozivu:

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

JSON socket zahtjevi moraju koristiti method i params. Stari v1 JSON formati poput {"command":"..."} nisu podržani.

Načini pristupa

Način	Opis	Kako omogućiti
Off	Socket onemogućen	UI postavki ili CMUX_SOCKET_MODE=off
cmux processes only	Samo procesi pokrenuti unutar cmux terminala se mogu povezati.	Podrazumijevani način u UI-ju postavki
allowAll	Dozvoli bilo kojem lokalnom procesu da se poveže (bez provjere porijekla).	Samo putem varijable okruženja: CMUX_SOCKET_MODE=allowAll

Na dijeljenim mašinama, koristite Isključeno ili Samo cmux procesi.

CLI opcije

Zastavica	Opis
`--socket PATH`	Prilagođena putanja socketa
`--json`	Izlaz u JSON formatu
`--window ID`	Ciljaj specifični prozor
`--workspace ID`	Ciljaj specifični radni prostor
`--surface ID`	Ciljaj specifičnu površinu
`--id-format refs\|uuids\|both`	Kontrola formata identifikatora u JSON izlazu

Komande radnih prostora

list-workspaces

Izlistaj sve otvorene radne prostore.

CLI

cmux list-workspaces
cmux list-workspaces --json

Socket

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

new-workspace

Kreiraj novi radni prostor.

CLI

cmux new-workspace

Socket

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

select-workspace

Prebaci se na specifični radni prostor.

CLI

cmux select-workspace --workspace <id>

Socket

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

current-workspace

Dobij trenutno aktivni radni prostor.

CLI

cmux current-workspace
cmux current-workspace --json

Socket

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

close-workspace

Zatvori radni prostor.

CLI

cmux close-workspace --workspace <id>

Socket

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

Komande razdjelnica

new-split

Kreiraj novi podijeljeni panel. Smjerovi: 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

Izlistaj sve površine u trenutnom radnom prostoru.

CLI

cmux list-surfaces
cmux list-surfaces --json

Socket

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

focus-surface

Fokusiraj specifičnu površinu.

CLI

cmux focus-surface --surface <id>

Socket

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

Komande unosa

send

Pošalji tekstualni unos u fokusirani terminal.

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

Pošalji pritisak tipke. Tipke: 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

Pošalji tekst na specifičnu površinu.

CLI

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

Socket

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

send-key-surface

Pošalji pritisak tipke na specifičnu površinu.

CLI

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

Socket

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

Komande notifikacija

notify

Pošalji notifikaciju.

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

Izlistaj sve notifikacije.

CLI

cmux list-notifications
cmux list-notifications --json

Socket

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

clear-notifications

Obriši sve notifikacije.

CLI

cmux clear-notifications

Socket

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

Komande metapodataka bočne trake

Postavite statusne oznake, trake napretka i zapise u bočnoj traci za bilo koji radni prostor. Korisno za build skripte, CI integracije i AI coding agente koji žele prikazati stanje na prvi pogled.

set-status

Postavite statusnu oznaku u bočnoj traci. Koristite jedinstveni ključ tako da različiti alati mogu upravljati svojim unosima.

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

Uklonite unos statusa bočne trake po ključu.

CLI

cmux clear-status build

Socket

clear_status build --tab=<workspace-uuid>

list-status

Izlistajte sve unose statusa bočne trake za radni prostor.

CLI

cmux list-status

Socket

list_status --tab=<workspace-uuid>

set-progress

Postavite traku napretka u bočnoj traci (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

Obrišite traku napretka bočne trake.

CLI

cmux clear-progress

Socket

clear_progress --tab=<workspace-uuid>

log

Dodajte zapis u dnevnik bočne trake. Nivoi: 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

Obrišite sve zapise dnevnika bočne trake.

CLI

cmux clear-log

Socket

clear_log --tab=<workspace-uuid>

list-log

Izlistajte zapise dnevnika bočne trake.

CLI

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

Socket

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

sidebar-state

Ispišite sve metapodatke bočne trake (cwd, git grana, portovi, status, napredak, dnevnici).

CLI

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

Socket

sidebar_state --tab=<workspace-uuid>

Pomoćne komande

ping

Provjerite da li cmux radi i odgovara.

CLI

cmux ping

Socket

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

capabilities

Izlistajte dostupne socket metode i trenutni način pristupa.

CLI

cmux capabilities
cmux capabilities --json

Socket

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

identify

Prikažite fokusirani kontekst prozora/radnog prostora/panela/površine.

CLI

cmux identify
cmux identify --json

Socket

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

Varijable okruženja

Varijabla	Opis
`CMUX_SOCKET_PATH`	Zaobiđite putanju socketa koju koriste CLI i integracije
`CMUX_SOCKET_ENABLE`	Prisilno omogućite/onemogućite socket (1/0, true/false, on/off)
`CMUX_SOCKET_MODE`	Zaobiđite način pristupa (cmuxOnly, allowAll, off). Takođe prihvata cmux-only/cmux_only i allow-all/allow_all
`CMUX_WORKSPACE_ID`	Automatski postavljeno: ID trenutnog radnog prostora
`CMUX_SURFACE_ID`	Automatski postavljeno: ID trenutne površine
`TERM_PROGRAM`	Postavljeno na ghostty
`TERM`	Postavljeno na xterm-ghostty

Starije CMUX_SOCKET_MODE vrijednosti full i notifications se još prihvataju radi kompatibilnosti.

Detekcija cmux-a

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"

Primjeri

Python klijent

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 skripta

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

Build skripta sa notifikacijom

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