Dock

Dock vous permet d'ajouter des contrôles TUI à la barre latérale droite. Chaque contrôle est une commande définie en JSON et rendue dans sa propre section de terminal basée sur Ghostty. Utilisez-le pour des flux, des logs, des files d'attente, l'état git, des serveurs de développement ou tout TUI que votre équipe veut garder près de chaque workspace.

Configuration

cmux recherche la configuration Dock dans cet ordre :

.cmux/dock.json pour le dépôt actuel, le projet parent le plus proche et les répertoires de projets imbriqués.
~/.config/cmux/dock.json pour votre Dock personnel par défaut ou lorsqu'il n'y a pas de dépôt.

Si une configuration de projet et une configuration globale existent toutes les deux, la configuration de projet l'emporte. Les configurations de projets imbriqués s'appliquent à leur arborescence. S'il n'existe aucune configuration de projet, Dock utilise la configuration globale. Si aucun fichier n'existe, Dock s'ouvre vide.

Les configurations Dock de projet peuvent lancer des commandes. cmux vous demande de faire confiance à une configuration de projet avant de lancer ses contrôles.

Exemple dock.json

Un fichier Dock est un objet JSON avec un tableau controls. Commitez les contrôles de projet dans .cmux/dock.json lorsque vous voulez que vos coéquipiers partagent le même Dock. Remplacez les commandes d'exemple par les outils réellement disponibles dans votre dépôt.

.cmux/dock.json

{
  "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
    }
  ]
}

Champs

Champ	Description
`id`	Identifiant unique et stable du contrôle. Gardez-le court et ne le réutilisez pas pour une autre commande.
`title`	Libellé affiché dans l'en-tête du Dock.
`command`	Commande à exécuter dans le terminal Dock. Elle démarre dans votre shell de connexion.
`cwd`	Répertoire de travail facultatif. Les chemins relatifs sont résolus depuis la racine du projet pour les configurations de projet, ou depuis votre dossier personnel pour les configurations globales.
`height`	Hauteur de terminal demandée facultative, en points. Les contrôles sans height partagent l'espace restant.
`env`	Variables d'environnement facultatives transmises uniquement à ce contrôle.

Partager avec une équipe

Dock est conçu pour être partagé avec le contrôle de version lorsque les commandes appartiennent au dépôt.

Placez les contrôles propres au dépôt dans .cmux/dock.json et commitez le fichier.
Placez les contrôles personnels dans ~/.config/cmux/dock.json, surtout hors d'un dépôt, et gardez ce fichier hors du contrôle de source partagé.
Ne mettez pas de secrets dans dock.json. Lisez les secrets depuis votre shell, un fichier env local ou vos outils de développement existants.

Demander à un agent de le configurer

Utilisez ce prompt quand vous voulez qu'un agent de code crée des contrôles Dock. Il demande à l'agent d'exécuter `cmux docs dock`, d'inspecter le projet et de poser une question avant de deviner.

Prompt d'agent

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.