Dock
Dock ti permette di aggiungere controlli TUI alla barra laterale destra. Ogni controllo è un comando definito in JSON e renderizzato nella propria sezione di terminale basata su Ghostty. Usalo per feed, log, code, stato git, server di sviluppo o qualunque TUI che il team vuole tenere vicino a ogni workspace.
Configurazione
cmux cerca la configurazione Dock in questo ordine:
.cmux/dock.jsonper il repository corrente, il progetto padre più vicino e le directory di progetti annidati.~/.config/cmux/dock.jsonper il Dock personale predefinito o quando non c’è un repository.
Esempio dock.json
Un file Dock è un oggetto JSON con un array controls. Fai commit dei controlli di progetto in .cmux/dock.json quando vuoi che i compagni di team condividano lo stesso Dock. Sostituisci i comandi di esempio con strumenti realmente presenti nel repository.
{
"controls": [
{
"id": "git",
"title": "Git",
"command": "lazygit",
"height": 300
},
{
"id": "logs",
"title": "Logs",
"command": "tail -f ./logs/development.log",
"cwd": "."
},
{
"id": "feed",
"title": "Feed",
"command": "cmux feed tui --opentui",
"height": 320
}
]
}Campi
| Campo | Descrizione |
|---|---|
id | Identificatore unico e stabile del controllo. Mantienilo breve e non riutilizzarlo per un altro comando. |
title | Etichetta mostrata nell'intestazione del Dock. |
command | Comando da eseguire nel terminale Dock. Si avvia nella tua shell di login. |
cwd | Directory di lavoro opzionale. I percorsi relativi vengono risolti dalla radice del progetto per le configurazioni di progetto o dalla home directory per le configurazioni globali. |
height | Altezza opzionale richiesta per il terminale, in punti. I controlli senza height condividono lo spazio rimanente. |
env | Variabili d'ambiente opzionali passate solo a quel controllo. |
Condivisione con un team
Dock è progettato per essere condiviso tramite source control quando i comandi appartengono al repository.
- Metti i controlli specifici del repo in .cmux/dock.json e committa il file.
- Metti i controlli personali in ~/.config/cmux/dock.json, soprattutto fuori da un repository, e tieni quel file fuori dal controllo sorgente condiviso.
- Non mettere segreti in dock.json. Leggi i segreti dalla shell, da un file env locale o dagli strumenti di sviluppo esistenti.
Chiedi a un agente di configurarlo
Usa questo prompt quando vuoi che un agente di coding crei controlli Dock. Indica all’agente di eseguire `cmux docs dock`, ispezionare il progetto e chiedere prima di tirare a indovinare.
Set up cmux Dock controls for the current context.
First, learn the feature before editing:
1. Run `cmux docs dock` if the cmux CLI is available. If it is not, read https://cmux.com/docs/dock.
2. Inspect the repository or current directory to understand the project type, scripts, package manager, dev servers, logs, task runners, test commands, and any existing TUI tools.
3. If the desired Dock is ambiguous, ask the user what they want monitored or controlled before writing files.
Dock is cmux's right-sidebar terminal control area. A Dock config is JSON with a top-level `controls` array. Each control runs a command in its own Ghostty-backed terminal section using the user's login shell. Controls are useful for project dashboards, git/status views, dev server or build status, test watchers, log tails, queues, local services, or a custom TUI such as `cmux feed tui --opentui` when that feed is useful.
Choose where to write the config:
- In a repository or project directory, create or edit `.cmux/dock.json` so teammates can share it.
- For a personal default outside a repo, create or edit `~/.config/cmux/dock.json`.
- If both exist, project `.cmux/dock.json` is more specific for that project. Nested project configs apply to that directory tree; use the nearest relevant project config instead of writing unrelated controls globally.
- If there is no repo and no clear project root, use the global config only after confirming the user wants a personal Dock.
Schema:
{
"controls": [
{
"id": "short-stable-id",
"title": "Human label",
"command": "safe command to run",
"cwd": "optional/path",
"height": 220,
"env": { "NAME": "value" }
}
]
}
Rules:
- Keep ids stable, lowercase, and unique.
- Use `cwd` for subdirectories; relative paths resolve from the config base.
- Use `height` only when a control needs a fixed amount of vertical space.
- Use `env` only for non-secret values needed by one control.
- Do not put secrets, tokens, or machine-specific private paths in a shared project config.
- Prefer commands that are safe to start repeatedly and make sense in a terminal.
- Do not invent unavailable scripts. Read package files, Makefiles, Procfiles, README docs, config files, and existing tooling first.
- Keep shared project Docks portable for teammates. Put personal or machine-specific controls in the global Dock.
Deliverable:
- Create or update the appropriate dock.json.
- Preserve existing useful controls unless the user asked to replace them.
- Validate that the JSON parses.
- Summarize what each control does and any commands the user should review before trusting the Dock config.