SkillsAdd

manaflow-ai/cmux

cmux-settings

View and edit cmux settings in ~/.config/cmux/cmux.json.

All-time #2483 Trending #2297 First seen May 15, 2026
8-week activity · all time api

Installation

$ npx skills add manaflow-ai/cmux --skill cmux-settings
View on skills.sh ↗ GitHub repository ↗

Summary

  • 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'.

Similar popular skills

Related neighbors and high-traction skills in the same topics — useful to compare before installing.

frontend-design Same topic
anthropics/skills

Guidance for distinctive, intentional visual design when building new UI or reshaping an existi…

866.4K installs
agent-browser Same topic
vercel-labs/agent-browser

Browser automation CLI for AI agents. Use when the user needs to interact with websites, includ…

810.4K installs
vercel-react-best-practices Same topic
vercel-labs/agent-skills 697.8K installs
web-design-guidelines Same topic
vercel-labs/agent-skills

Review UI code for Web Interface Guidelines compliance. Use when asked to "review my UI", "chec…

617.3K installs
microsoft-foundry Same topic
microsoft/azure-skills

Build, deploy, evaluate, optimize, fine-tune, and manage Microsoft Foundry agents, models, and …

576.5K installs
azure-diagnostics Same topic
microsoft/azure-skills

Debug Azure production issues on Azure using AppLens, Azure Monitor, resource health, and safe …

568.9K installs

Also in this package

Other skills from manaflow-ai/cmux · top by installs.

npx skills add manaflow-ai/cmux
cmux 7.9K cmux-browser 7.4K cmux-markdown 6.4K cmux-workspace 5.5K cmux-diagnostics 5.3K cmux-customization 5.4K cmux-keyboard-shortcuts 5K cmux-dev-workflow 3.7K cmux-architecture 3.7K cmux-testing 3.8K

Browse all from manaflow-ai/cmux

More details

Agent compatibility

Declared targets from SKILL.md / docs. Unmarked agents are not listed — the skill may still install via the CLI.

Claude Code Not declared
Cursor Not declared
Codex Declared
GitHub Copilot Not declared
Windsurf Not declared
Gemini CLI Not declared
Cline Not declared
OpenCode Not declared

Repository health

Stars 26.9K
License LICENSE
Default branch main
Open issues 1,826
Status Active

Skill metadata

Parsed from SKILL.md frontmatter.

Declared agents codex

Package contents

Files included with this skill beyond the listing page.

  • skill md SKILL.md 5,065 B
  • docs SUMMARY.md 441 B

History

  1. First seen on skills.sh
  2. First recorded snapshot · 5,800 installs

SKILL.md

cmux-settings

cmux reads user settings from ~/.config/cmux/cmux.json (JSONC). A file watcher applies changes on save, no restart. Legacy ~/.config/cmux/settings.json is read only as a fallback for keys absent from cmux.json.

Schema: https://raw.githubusercontent.com/manaflow-ai/cmux/main/web/data/cmux.schema.json. The authoritative path list is Sources/CmuxSettingsJSONPathSupport.swift; the installed skill carries a generated copy in references/all-keys.md. Settings sections are app, terminal, notifications, sidebar, sidebarAppearance, workspaceColors, automation, browser, shortcuts. Non-settings sections (actions, ui, commands, vault, rightSidebar) share the same file.

Helper script

Use the bundled helper for every read/write. It strips JSONC comments, writes atomically, and validates keys against the schema.

skills/cmux-settings/scripts/cmux-settings <subcommand>            # from a cmux checkout
~/.codex/skills/cmux-settings/scripts/cmux-settings <subcommand>   # installed Codex skill

The rest of this doc assumes it is on $PATH as cmux-settings; from a checkout, export PATH="$PWD/skills/cmux-settings/scripts:$PATH".

Command What it does
cmux-settings path Print the config path.
cmux-settings dump Print the raw file (preserves comments).
cmux-settings dump --no-comments Print the parsed JSON.
cmux-settings get <a.b.c> Print value at dotted JSON path.
cmux-settings set <a.b.c> <value> Set value. <value> is parsed as JSON (true, 42, "text", […], {…}); unquoted plain words are stored as strings.
cmux-settings unset <a.b.c> Delete key, reverting to the in-app default.
cmux-settings list-supported List every settings JSON path the app recognizes.
cmux-settings validate Parse the file and flag unknown settings keys.
cmux-settings open Open cmux.json in $EDITOR, VS Code, Cursor, or TextEdit.

--file <path> overrides the target file, useful for --file ~/.config/cmux/settings.json.

Workflow

  1. Look up the key when the user named a setting in plain English:

``bash cmux-settings list-supported | rg -i 'sidebar.terminal|terminal.sidebar' ``

  1. Set it. JSON literals must be valid JSON.

``bash cmux-settings set sidebarAppearance.matchTerminalBackground true cmux-settings set app.appearance dark cmux-settings set shortcuts.bindings.newTab '["ctrl+b","c"]' cmux-settings set browser.hostsToOpenInEmbeddedBrowser '["localhost","*.internal.example"]' ``

  1. Read back and cmux-settings validate.
  2. Tell the user it auto-reloaded, and that cmux-settings unset <key> reverts it.

Quick reference

  • Appearance: app.appearance ("system" | "light" | "dark"), app.appIcon, app.menuBarOnly, app.minimalMode.
  • Sidebar tint: sidebarAppearance.matchTerminalBackground, .tintColor, .tintOpacity (0..1).
  • Sidebar details: sidebar.hideAllDetails, .showBranchDirectory, .showPullRequests, .showPorts, .showLog.
  • Notifications: notifications.dockBadge, .sound (enum including "none", "custom_file"), .customSoundFilePath, .hooks (array).
  • Browser: browser.defaultSearchEngine, .theme, .defaultZoomLevel, .openTerminalLinksInCmuxBrowser, .hostsToOpenInEmbeddedBrowser.
  • Automation: automation.socketControlMode (off | cmuxOnly | automation | password | allowAll), .portBase, .portRange.
  • Shortcuts: shortcuts.bindings.<actionId> = "cmd+b", ["ctrl+b","c"], null, or "" to unbind. Action ids in [references/shortcut-actions.md](references/shortcut-actions.md).

Full list of settings, defaults, and descriptions: cmux-settings list-supported or [references/all-keys.md](references/all-keys.md).

Rules

  • Only edit cmux.json. Never settings.json unless the user explicitly asks; it is legacy and read only when a key is absent from cmux.json.
  • Never tell the user to restart cmux. The file watcher reloads on save.
  • Always cmux-settings validate after a bulk edit. Unknown keys mean the user pasted a key the app does not consume.
  • Do not blindly overwrite actions, ui, commands, vault, or rightSidebar; they share the file and hold hand-tuned non-settings config.
  • Shortcut action ids must match the schema enum. Look them up before binding.
  • Colors are #RRGGBB; opacities are 0..1.
  • Translate app-level phrasing ("Settings > Notifications > Dock badge") to the JSON path first; web/app/[locale]/(landing)/docs/configuration/page.tsx mirrors the schema 1:1.