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.