agentleFS
Sign inStart free
manaflow-aimanaflow-ai/cmux-skills/skills/cmux-config/SKILL.md

cmux-config

Skill35 starsChanged 5 months agoMITView on GitHub

Configure cmux through ~/.config/cmux/cmux.json: settings (appearance, sidebar, notifications, automation, browser, shortcuts, set/get/validate by JSON path), customization (tab bar buttons, plus-button click and right-click menus, custom actions/commands/menus, right sidebar), and sidebar workspace groups (anchor workspaces, group CLI/socket ops, per-cwd group config). Triggers: 'cmux config', 'cmux.json', 'change cmux setting', 'set <x> in cmux', 'rebind a cmux shortcut', 'cmux-customize', 'customize cmux', 'tab bar button', 'add cmux action', 'workspace group', 'group sidebar', 'anchor workspace', 'workspaceGroups'.

We split this skill into the rules it gives an agent

8 rules. About 0 are common, 4 are distinctive, and 4 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈4

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 4

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Use the bundled helper for every settings/customize read and write.

    line 28
  2. Very specific:

    If the user named a setting in plain English, look it up first: cmux-settings list-supported | rg -i '<keywords>'.

    line 56
  3. Very specific:

    Typed settings: read back (cmux-settings get <path>) and cmux-settings validate.

    line 61
  4. Distinctive:

    Check the key against references/customize.md.

    line 66
  5. Very specific:

    Only edit cmux.json. Never edit settings.json unless asked.

    line 74
  6. Distinctive:

    Never tell the user to restart cmux to apply a change.

    line 75
  7. Very specific:

    Do not blindly overwrite top-level structural sections (actions, ui, commands, vault, rightSidebar).

    line 76
  8. Distinctive:

    Do not run a tagged app reload for config-only or skill-only changes.

    line 81

≈ “Common” is an estimate: at least 1 in 5 of the 308,232 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

cmux-config

Single entry point for editing a user's cmux configuration in ~/.config/cmux/cmux.json (JSONC). The app watches the file; saving applies changes immediately, no restart. Legacy ~/.config/cmux/settings.json is read only as a fallback for keys absent from cmux.json.

Three areas, each with a reference:

  • Settings — typed preferences under app, terminal, notifications, sidebar, sidebarAppearance, workspaceColors, automation, browser, shortcuts. See the helper below and references/all-keys.md / references/shortcut-actions.md.
  • Customization — structural config: actions, ui.surfaceTabBar.buttons, ui.newWorkspace (plus-button click + context menu), commands, rightSidebar, vault. See references/customize.md.
  • Workspace groups — collapsible anchor-owned sidebar sections via the cmux workspace group CLI / socket API and workspaceGroups config. See references/groups.md.

Helper script

Use the bundled helper for every settings/customize read and write. It strips JSONC comments, writes atomically, and validates keys against the schema. From the installed skill directory:

./scripts/cmux-settings <subcommand>

For brevity below, assume it is on $PATH as cmux-settings (e.g. export PATH="$HOME/.claude/skills/cmux-config/scripts:$PATH").

CommandWhat it does
cmux-settings pathPrint the config path.
cmux-settings dump [--no-comments]Print the raw file (or parsed JSON).
cmux-settings get <a.b.c>Print value at dotted JSON path.
cmux-settings set <a.b.c> <value>Set value (<value> parsed as JSON; bare words stored as strings).
cmux-settings unset <a.b.c>Delete key, reverting to the in-app default.
cmux-settings list-supportedList every settings JSON path the app recognizes.
cmux-settings validateParse the file and flag unknown settings keys.
cmux-settings openOpen cmux.json in $EDITOR / VS Code / Cursor / TextEdit.

--file <path> overrides the target file (use for the legacy settings.json).

Schema: https://raw.githubusercontent.com/manaflow-ai/cmux/main/web/data/cmux.schema.json.

Workflow

  1. If the user named a setting in plain English, look it up first: cmux-settings list-supported | rg -i '<keywords>'.
  2. Make the smallest edit (settings/customize via the helper; groups via the cmux workspace group CLI in references/groups.md).
  3. Verify by surface:
    • Typed settings: read back (cmux-settings get <path>) and cmux-settings validate.
    • Customization (actions, ui.*, commands, vault, rightSidebar): read back the exact key (cmux-settings get <path>) and confirm the file still parses (cmux-settings dump --no-comments). Do NOT rely on validate here: it skips structural sections, so a typo like ui.surfaceTabbar.buttons passes validation yet cmux ignores it. Check the key against references/customize.md.
    • Groups: cmux workspace group list (the settings validator does not recognize workspaceGroups).
  4. Tell the user it auto-reloaded on save. No app restart. Revert with cmux-settings unset <key>.

Rules

  • Only edit cmux.json. Never edit settings.json unless asked; it is legacy.
  • Never tell the user to restart cmux to apply a change; the watcher reloads on save.
  • Do not blindly overwrite top-level structural sections (actions, ui, commands, vault, rightSidebar); they hold hand-tuned non-settings config.
  • Color values are #RRGGBB; opacities are 0..1.
  • Shortcut action ids must match the schema enum; look them up in references/shortcut-actions.md before binding.
  • Do not run a tagged app reload for config-only or skill-only changes.
  • For workspace groups prefer CLI/socket operations over editing session JSON, and preserve anchor semantics (see references/groups.md).

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

Check your setup, free