Dock

Dock позволяет добавлять TUI-элементы управления в правую боковую панель. Каждый элемент управления это команда из JSON, отображаемая в собственной секции терминала на базе Ghostty. Используйте его для лент, логов, очередей, статуса git, dev-серверов или любого TUI, который команда хочет видеть рядом с каждым workspace.

Конфигурация

cmux ищет конфигурацию Dock в таком порядке:

.cmux/dock.json для текущего репозитория, ближайшего родительского проекта и вложенных каталогов проектов.
~/.config/cmux/dock.json для личного Dock по умолчанию или для случаев, когда репозитория нет.

Если существуют и проектная, и глобальная конфигурации, приоритет имеет проектная. Конфигурации вложенных проектов применяются к своему дереву каталогов. Если проектной конфигурации нет, Dock использует глобальную. Если ни одного файла нет, Dock открывается пустым.

Проектные конфигурации Dock могут запускать команды. cmux просит доверять проектной конфигурации перед запуском ее элементов управления.

Пример dock.json

Файл Dock это JSON-объект с массивом controls. Добавляйте проектные элементы управления в .cmux/dock.json и коммитьте файл, когда хотите поделиться тем же Dock с командой. Замените примеры команд инструментами, которые действительно есть в репозитории.

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

Поля

Поле	Описание
`id`	Стабильный уникальный идентификатор элемента управления. Держите его коротким и не используйте повторно для другой команды.
`title`	Метка, показанная в заголовке Dock.
`command`	Команда для запуска в терминале Dock. Она стартует внутри вашего login shell.
`cwd`	Необязательный рабочий каталог. Относительные пути разрешаются от корня проекта для проектных конфигураций или от домашнего каталога для глобальных конфигураций.
`height`	Необязательная запрошенная высота терминала в пунктах. Элементы управления без height делят оставшееся место.
`env`	Необязательные переменные окружения, передаваемые только этому элементу управления.

Совместное использование в команде

Dock рассчитан на совместное использование через source control, когда команды относятся к репозиторию.

Поместите элементы управления для репозитория в .cmux/dock.json и закоммитьте файл.
Помещайте личные элементы управления в ~/.config/cmux/dock.json, особенно вне репозитория, и не добавляйте этот файл в общий контроль версий.
Не помещайте секреты в dock.json. Читайте секреты из shell, локального env-файла или существующих инструментов разработки.

Попросите агента настроить это

Используйте этот промпт, когда хотите, чтобы coding agent создал элементы Dock. Он просит агента выполнить `cmux docs dock`, изучить проект и спросить перед тем, как что-либо предполагать.

Промпт агента

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.