Dock
يتيح لك Dock إضافة عناصر تحكم TUI إلى الشريط الجانبي الأيمن. كل عنصر تحكم هو أمر معرف في JSON ويعرض في قسم طرفية خاص مدعوم من Ghostty. استخدمه للخلاصات أو السجلات أو الطوابير أو حالة git أو خوادم التطوير أو أي TUI يريد فريقك إبقاءه بجانب كل مساحة عمل.
الإعداد
يبحث 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 ليشارك عبر التحكم بالمصدر عندما تكون الأوامر تابعة للمستودع.
- ضع عناصر التحكم الخاصة بالمستودع في .cmux/dock.json واحفظ الملف في git.
- ضع عناصر التحكم الشخصية في ~/.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.