How to install cmux-diagnostics
npx skills add null --skill cmux-diagnosticsFull instructions (SKILL.md)
Source of truth, from manaflow-ai/cmux.
name: cmux-diagnostics description: "Run end-user cmux diagnostics. Use when cmux hooks, notifications, session restore, settings, browser automation, socket access, CLI control, or agent resume behavior is not working, or when the user asks for a cmux health check, doctor report, or support-safe debug summary."
cmux Diagnostics
Use this skill to collect and interpret support-safe cmux diagnostics for end users. Default to read-only checks. Do not dump hook config files, session stores, prompt logs, tokens, or environment secrets.
Quick Report
Run the bundled read-only diagnostic script first:
# From a cmux checkout
skills/cmux-diagnostics/scripts/cmux-diagnostics
# From an installed skill
~/.agents/skills/cmux-diagnostics/scripts/cmux-diagnostics
# From a Codex-only skills.sh install
~/.codex/skills/cmux-diagnostics/scripts/cmux-diagnostics
Use --include-context only when workspace names, cwd paths, and current cmux identifiers are relevant to the user-reported issue:
skills/cmux-diagnostics/scripts/cmux-diagnostics --include-context
What to Check
-
CLI and socket health:
command -v cmux cmux ping cmux capabilities --jsonIf socket commands fail, check whether the agent is running inside a cmux terminal and whether socket automation is enabled.
-
Settings health:
~/.agents/skills/cmux-settings/scripts/cmux-settings validate ~/.agents/skills/cmux-settings/scripts/cmux-settings get terminal.autoResumeAgentSessionsIf the user installed with
skills.sh, use~/.codex/skills/cmux-settings/scripts/cmux-settingsinstead. Ifterminal.autoResumeAgentSessionsis false, cmux restores panes but will not automatically resume saved agent sessions. -
Hook installation:
cmux hooks setup --agent codex cmux hooks setup --agent opencode cmux hooks setupOnly run install or uninstall commands after the user agrees.
cmux hooks setupinstalls supported agents found on PATH and skips missing agents. -
Session restore evidence:
ls -lh ~/.cmuxterm/*-hook-sessions.json 2>/dev/nullMissing session stores usually means the agent has not run inside cmux since hooks were installed, hooks are disabled, or the agent integration does not support resume capture.
-
Notification path:
cmux notify "cmux diagnostic test"Use this only when the user is ready for a visible test notification.
Interpretation
cmuxnot found: the CLI is not installed or not on PATH for this shell.cmux pingfails: app is not reachable through the current socket path, the app is closed, or automation access is disabled.- No
CMUX_WORKSPACE_IDorCMUX_SURFACE_ID: the command is probably running outside a cmux terminal. Some hooks intentionally no-op outside cmux. - Hook config exists but no session store: run one supported agent inside cmux after installing hooks, then re-check.
- Session store exists but restore does not launch agents: check
terminal.autoResumeAgentSessionsand whether the saved executable still exists on PATH. - Settings validation fails: fix the config first. Invalid config can make later symptoms misleading.
Rules
- Stay read-only until the user asks to fix something.
- Never print raw hook files, session JSON, prompt logs, shell history, tokens, or API keys.
- Summarize file presence, size, modified time, and marker presence instead of contents.
- Prefer narrow fixes such as
cmux hooks setup --agent codexover reinstalling every integration. - After a fix, rerun the diagnostic script and report the changed lines.
Related skills
More from manaflow-ai/cmux and the wider catalog.
cmux
End-user control of cmux topology and routing (windows, workspaces, panes/surfaces, focus, moves, reorder, identify, trigger flash). Use when automation needs deterministic placement and navigation in a multi-pane cmux layout.
cmux-browser
End-user browser automation with cmux. Use when you need to open sites, interact with pages, wait for state changes, and extract data from cmux browser surfaces.
cmux-markdown
Open markdown files in a formatted viewer panel with live reload. Use when you need to display plans, documentation, or notes alongside the terminal with rich rendering (headings, code blocks, tables, lists).
cmux-settings
View and edit cmux settings in ~/.config/cmux/cmux.json. Use when the user wants to change cmux preferences (appearance, sidebar, notifications, automation, browser, shortcuts), set a value by JSON path, validate the file, open it in an editor, or look up which keys cmux recognizes. Triggers on '/cmux-settings', 'change cmux setting', 'set <something> in cmux', 'cmux config', 'cmux.json', or 'rebind a cmux shortcut'.
cmux-workspace
Work inside the current cmux workspace and terminal. Use for cmux workspace, current workspace, caller surface, panes, surfaces, socket targeting, and non-interfering cmux automation.
cmux-customization
Customize cmux for an end user. Use when changing cmux.json actions, custom commands, workspace layouts, plus-button behavior, surface tab bar buttons, Command Palette entries, Dock controls, sidebar and app settings, shortcuts, notifications, browser routing, examples-library presets, or Ghostty-backed terminal preferences.