Dock

Dock te permite agregar controles TUI a la barra lateral derecha. Cada control es un comando definido en JSON y se muestra en su propia sección de terminal basada en Ghostty. Úsalo para feeds, registros, colas, estado de git, servidores de desarrollo o cualquier TUI que tu equipo quiera tener junto a cada workspace.

Configuración

cmux busca la configuración de Dock en este orden:

.cmux/dock.json para el repositorio actual, el proyecto padre más cercano y los directorios de proyectos anidados.
~/.config/cmux/dock.json para tu Dock personal predeterminado o cuando no hay repositorio.

Si existen una configuración de proyecto y una global, gana la configuración del proyecto. Las configuraciones de proyectos anidados se aplican a su árbol de directorios. Si no existe configuración de proyecto, Dock usa la configuración global. Si no existe ningún archivo, Dock se abre vacío.

Las configuraciones de Dock del proyecto pueden iniciar comandos. cmux te pide confiar en una configuración de proyecto antes de iniciar sus controles.

Ejemplo de dock.json

Un archivo Dock es un objeto JSON con un array controls. Haz commit de los controles del proyecto en .cmux/dock.json cuando quieras que tus compañeros compartan el mismo Dock. Sustituye los comandos de ejemplo por herramientas que tu repositorio realmente tenga.

.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
    }
  ]
}

Campos

Campo	Descripción
`id`	Identificador único y estable del control. Mantenlo corto y no lo reutilices para otro comando.
`title`	Etiqueta que se muestra en el encabezado de Dock.
`command`	Comando que se ejecuta en el terminal de Dock. Se inicia dentro de tu shell de inicio de sesión.
`cwd`	Directorio de trabajo opcional. Las rutas relativas se resuelven desde la raíz del proyecto para configuraciones de proyecto o desde tu directorio de inicio para configuraciones globales.
`height`	Altura de terminal solicitada opcional en puntos. Los controles sin height comparten el espacio restante.
`env`	Variables de entorno opcionales que se pasan solo a ese control.

Compartir con un equipo

Dock está diseñado para compartirse con control de código fuente cuando los comandos pertenecen al repositorio.

Pon los controles específicos del repositorio en .cmux/dock.json y confirma el archivo.
Pon los controles personales en ~/.config/cmux/dock.json, especialmente fuera de un repositorio, y mantén ese archivo fuera del control de código fuente compartido.
No pongas secretos en dock.json. Lee los secretos desde tu shell, un archivo env local o tus herramientas de desarrollo existentes.

Pídele a un agente que lo configure

Usa este prompt cuando quieras que un agente de código cree controles Dock. Le indica al agente que ejecute `cmux docs dock`, inspeccione el proyecto y pregunte antes de adivinar.

Prompt del agente

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.