# CLI-referanse

cmux tilbyr både et CLI-verktøy og en Unix-socket for programmatisk kontroll. Hver kommando er tilgjengelig gjennom begge grensesnittene.

## Socket

| Build | Sti |
| --- | --- |
| Release | `/tmp/cmux.sock` |
| Debug | `/tmp/cmux-debug.sock` |
| Tagget debug-build | `/tmp/cmux-debug-<tag>.sock` |

Overstyr med CMUX\_SOCKET\_PATH-miljøvariabelen. Send én JSON-forespørsel terminert med linjeskift per kall:

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

JSON-socketforespørsler må bruke method og params. Eldre v1 JSON-nyttelaster som `{"command":"..."}` støttes ikke.

## Tilgangsmoduser

| Modus | Beskrivelse | Hvordan aktivere |
| --- | --- | --- |
| **Off** | Socket deaktivert | Innstillings-UI eller CMUX\_SOCKET\_MODE=off |
| **cmux processes only** | Bare prosesser startet inne i cmux-terminaler kan koble til. | Standardmodus i innstillings-UI |
| **allowAll** | Tillat enhver lokal prosess å koble til (ingen herkomstsjekk). | Kun miljøvariabeloverstyring: CMUX\_SOCKET\_MODE=allowAll |

På delte maskiner, bruk Av eller Bare cmux-prosesser.

## CLI-alternativer

| Flagg | Beskrivelse |
| --- | --- |
| `--socket PATH` | Egendefinert socket-sti |
| `--json` | Utdata i JSON-format |
| `--window ID` | Mål et spesifikt vindu |
| `--workspace ID` | Mål et spesifikt arbeidsområde |
| `--surface ID` | Mål en spesifikk overflate |
| `--id-format refs|uuids|both` | Kontroller identifikatorformat i JSON-utdata |

## Arbeidsområdekommandoer

#### list-workspaces

List alle åpne arbeidsområder.

CLI

```
cmux list-workspaces
cmux list-workspaces --json
```

Socket

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

#### new-workspace

Opprett et nytt arbeidsområde.

CLI

```
cmux new-workspace
```

Socket

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

#### select-workspace

Bytt til et spesifikt arbeidsområde.

CLI

```
cmux select-workspace --workspace <id>
```

Socket

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

#### current-workspace

Hent det aktive arbeidsområdet.

CLI

```
cmux current-workspace
cmux current-workspace --json
```

Socket

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

#### close-workspace

Lukk et arbeidsområde.

CLI

```
cmux close-workspace --workspace <id>
```

Socket

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

## Delingskommandoer

#### new-split

Opprett et nytt delt panel. Retninger: left, right, up, down.

CLI

```
cmux new-split right
cmux new-split down
cmux new-split down --command "npm run dev"
```

Socket

```
{"id":"split-new","method":"surface.split","params":{"direction":"right"}}
{"id":"split-cmd","method":"surface.split","params":{"direction":"down","initial_input":"npm run dev\r"}}
```

#### list-panels

List alle overflater i det gjeldende arbeidsområdet.

CLI

```
cmux list-panels
cmux list-panels --json
```

Socket

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

#### list-pane-surfaces

List overflater i det fokuserte panelet.

CLI

```
cmux list-pane-surfaces
cmux list-pane-surfaces --json
```

Socket

```
{"id":"pane-surfaces","method":"pane.surfaces","params":{}}
```

#### focus-panel

Fokuser en spesifikk overflate.

CLI

```
cmux focus-panel --panel <id>
```

Socket

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

## Inndatakommandoer

#### send

Send tekstinndata til den fokuserte terminalen.

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

Send et tastetrykk. Taster: 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

Send tekst til en spesifikk overflate.

CLI

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

Socket

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

#### send-key --surface

Send et tastetrykk til en spesifikk overflate.

CLI

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

Socket

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

## Varselkommandoer

#### notify

Send et varsel.

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

List alle varsler.

CLI

```
cmux list-notifications
cmux list-notifications --json
```

Socket

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

#### clear-notifications

Fjern alle varsler.

CLI

```
cmux clear-notifications
```

Socket

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

## Sidefeltmetadatakommandoer

Sett statuspiller, fremdriftslinjer og loggoppføringer i sidefeltet for ethvert arbeidsområde. Nyttig for build-skript, CI-integrasjoner og AI-kodeagenter som vil vise tilstand med et øyekast.

#### set-status

Sett en sidefelt-statuspille. Bruk en unik nøkkel slik at forskjellige verktøy kan administrere sine egne oppføringer.

CLI

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

Socket

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

#### clear-status

Fjern en sidefelt-statusoppføring etter nøkkel.

CLI

```
cmux clear-status build
```

Socket

```
clear_status build --tab=<workspace-uuid>
```

#### list-status

List alle sidefelt-statusoppføringer for et arbeidsområde.

CLI

```
cmux list-status
```

Socket

```
list_status --tab=<workspace-uuid>
```

#### set-progress

Sett en fremdriftslinje i sidefeltet (0.0 til 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

Fjern sidefeltets fremdriftslinje.

CLI

```
cmux clear-progress
```

Socket

```
clear_progress --tab=<workspace-uuid>
```

#### log

Legg til en loggoppføring i sidefeltet. Nivåer: 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

Fjern alle sidefeltets loggoppføringer.

CLI

```
cmux clear-log
```

Socket

```
clear_log --tab=<workspace-uuid>
```

#### list-log

List sidefeltets loggoppføringer.

CLI

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

Socket

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

#### sidebar-state

Dump all sidefeltmetadata (cwd, git-gren, porter, status, fremdrift, logger).

CLI

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

Socket

```
sidebar_state --tab=<workspace-uuid>
```

## Hjelpekommandoer

#### ping

Sjekk om cmux kjører og svarer.

CLI

```
cmux ping
```

Socket

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

#### capabilities

List tilgjengelige socket-metoder og gjeldende tilgangsmodus.

CLI

```
cmux capabilities
cmux capabilities --json
```

Socket

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

#### identify

Vis fokusert vindu/arbeidsområde/panel/overflate-kontekst.

CLI

```
cmux identify
cmux identify --json
```

Socket

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

## Miljøvariabler

| Variabel | Beskrivelse |
| --- | --- |
| `CMUX_SOCKET_PATH` | Overstyr socket-stien brukt av CLI og integrasjoner |
| `CMUX_SOCKET_ENABLE` | Tvangsaktiver/deaktiver socket (1/0, true/false, on/off) |
| `CMUX_SOCKET_MODE` | Overstyr tilgangsmodus (cmuxOnly, allowAll, off). Godtar også cmux-only/cmux\_only og allow-all/allow\_all |
| `CMUX_WORKSPACE_ID` | Automatisk satt: gjeldende arbeidsområde-ID |
| `CMUX_SURFACE_ID` | Automatisk satt: gjeldende overflate-ID |
| `TERM_PROGRAM` | Satt til ghostty |
| `TERM` | Satt til xterm-ghostty |

Eldre CMUX\_SOCKET\_MODE-verdier full og notifications godtas fortsatt for kompatibilitet.

## Oppdage 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"
```

## Eksempler

### Python-klient

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-skript

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-skript med varsel

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
```

Canonical: https://cmux.com/no/docs/api

Documentation index: https://cmux.com/llms.txt