cmux-diagnostics
manaflow-ai/cmux
Diagnose cmux integration issues: hooks, notifications, session restore, settings, and socket access.
What is cmux-diagnostics?
Run read-only diagnostics to troubleshoot cmux functionality including CLI health, hook installation, session restore, settings validation, and notifications. Use this when cmux features are not working or the user requests a health check or debug report.
- Check CLI and socket health with cmux ping and capabilities
- Validate cmux settings and agent session auto-resume configuration
- Verify hook installation for supported agents (codex, opencode)
- Detect session restore evidence and diagnose restore failures
- Test notification delivery through cmux notify
- Interpret common failure modes and guide narrow fixes
How to install cmux-diagnostics
npx skills add null --skill cmux-diagnostics- cmux CLI installed and accessible on PATH
- Access to ~/.agents/skills/cmux-diagnostics or equivalent skill directory
- Optional: cmux-settings skill for advanced settings validation
How to use cmux-diagnostics
- 1.Run the bundled diagnostic script: ~/.agents/skills/cmux-diagnostics/scripts/cmux-diagnostics
- 2.Add --include-context flag only if workspace names and paths are relevant to the issue
- 3.Review the output against the Interpretation section to identify root causes
- 4.Stay read-only; only run install/fix commands after user agreement
- 5.After any fix, rerun the diagnostic script and report changed lines
Use cases
- User reports cmux hooks are not working or sessions are not resuming
- Agent cannot communicate with cmux through socket automation
- Need to verify hook installation after setting up cmux integrations
- Diagnose why browser automation or CLI control is failing in cmux
- Generate support-safe debug summary without exposing secrets or logs
- cmux end users troubleshooting integration issues
- Support staff gathering diagnostic data from users
- Developers verifying cmux hook and session restore setup
- Anyone needing a health check before deeper cmux debugging
cmux-diagnostics FAQ
It verifies CLI and socket health (cmux ping, capabilities), settings validation, hook installation status, session store presence, and notification delivery. It stays read-only and never exposes secrets, logs, or hook config contents.
Only when workspace names, current working directory paths, or cmux identifiers are directly relevant to the user-reported issue. Omit it by default to keep output support-safe.
The app is not reachable through the socket, the app is closed, or socket automation is disabled. Check whether the agent is running inside a cmux terminal and whether socket access is enabled in settings.
Check that terminal.autoResumeAgentSessions is true, the agent has run inside cmux at least once since hooks were installed, and the saved executable still exists on PATH.
No. The diagnostic script summarizes file presence, size, and modification time instead of printing contents to keep output support-safe and avoid exposing sensitive data.
Full 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
Control cmux topology, panes, workspaces, and focus for deterministic multi-pane terminal navigation.
cmux-browser
Browser automation for cmux webviews: open sites, interact with pages, wait for changes, extract data.
cmux-markdown
Display markdown files in a formatted panel with live reload alongside your terminal.
cmux-settings
View and edit cmux settings in ~/.config/cmux/cmux.json with validation and live reload.
cmux-workspace
Work within the current cmux workspace and terminal without disrupting user focus.
cmux-customization
Customize cmux configuration, actions, layouts, and terminal behavior for end users.