cmux-settings

View, edit, and validate cmux settings in cmux.json via a helper script.

4.0k|282|Updated Dec 2, 2024
One-click install
npx skills add https://github.com/basicmachines-co/basic-memory --skill cmux-settings-basicmachines-co
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: cmux-settings
Source: https://github.com/basicmachines-co/basic-memory/tree/main/.agents/skills/cmux-settings
Command: npx skills add https://github.com/basicmachines-co/basic-memory --skill cmux-settings-basicmachines-co

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve? Editing cmux preferences requires knowing the exact JSON paths in ~/.config/cmux/cmux.json, handling JSONC comments, and avoiding keys the app does not recognize. This Skill maps plain-English setting requests to valid JSON paths, applies changes safely, and validates the result. ## Core Features & Use Cases - Safe read/write helper: A bundled script strips JSONC comments, writes atomically, and supports get, set, unset, dump, and open subcommands. - Schema validation: The validate command flags unknown keys against the official cmux schema, and list-supported enumerates every recognized settings path. - Shortcut rebinding: Set or unbind keyboard shortcuts using action ids from the generated reference, with support for chords and unbinding values. - Use Case: A user says "make the sidebar match my terminal background." The Skill looks up the key, runs cmux-settings set sidebarAppearance.matchTerminalBackground true, validates the file, and confirms the change auto-reloads with no restart. ## Quick Start Ask the assistant to change a cmux preference, such as setting the app appearance to dark mode, and let it apply and validate the change in cmux.json.

Frequently Asked Questions about cmux-settings

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I change cmux settings from the command line?▼

Use the bundled cmux-settings helper script with subcommands like get, set, and unset targeting dotted JSON paths in cmux.json. For example, `cmux-settings set app.appearance dark` updates the appearance, and the file watcher applies it without restarting cmux.

How do I rebind a keyboard shortcut in cmux?▼

Set shortcuts.bindings.<actionId> to a string like "cmd+b", a chord array like ["ctrl+b","c"], or null to unbind. Valid action ids are listed in the shortcut-actions reference and must match the schema enum.

Do I need to restart cmux after editing cmux.json?▼

No. cmux watches ~/.config/cmux/cmux.json and reloads settings automatically on save. You should never be told to restart the app after a settings change.

What is the difference between cmux.json and settings.json?▼

cmux.json is the primary settings file and the only one you should edit. The legacy settings.json is read only as a fallback for keys absent from cmux.json, so edits there are ignored once a key exists in cmux.json.

Why does cmux ignore a key I added to the config file?▼

The key is likely not recognized by the app. Run `cmux-settings validate` to flag unknown settings keys, and use `cmux-settings list-supported` to find the correct path the app actually consumes.