Agent skill

cmux Settings Editor

by basicmachines-co in basicmachines-co/basic-memory

Views, sets, unsets and validates cmux settings in ~/.config/cmux/cmux.json with a helper script that checks keys against the schema.

AGPL-3.0Auto-check passedProductivity & Automation

Install cmux Settings Editor

skills CLI
$ npx skills add basicmachines-co/basic-memory --skill cmux-settings -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI
$ gh skill install basicmachines-co/basic-memory cmux-settings --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy
$ git clone --depth 1 https://github.com/basicmachines-co/basic-memory.git skills-src && mkdir -p .claude/skills && cp -r skills-src/.agents/skills/cmux-settings .claude/skills/cmux-settings && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Facts

Skill name
cmux-settings
GitHub stars
4.1k
Used in
1 other repo
Token cost
~1.3k tokens
SKILL.md length
439 words
Files
5 (incl. scripts, references)
Skills in repo
49
Repo updated
First seen
Licence
AGPL-3.0

At a glance

Views, sets, unsets and validates cmux settings in ~/.config/cmux/cmux.json with a helper script that checks keys against the schema.

  • Works in 4 steps: Look up the key when the user named a… → Set it. JSON literals must be valid JSON. → Read back and cmux-settings validate. → …
  • Changing a cmux preference such as appearance or sidebar behavior
  • SKILL.md covers Helper script, Workflow, Quick reference and Rules
  • Calls rg; reaches raw.githubusercontent.com

What it does

cmux reads settings from ~/.config/cmux/cmux.json, a JSONC file that a watcher applies on save without a restart, with an older settings.json used only as a fallback for keys that are missing. The skill requires every read and write to go through the bundled cmux-settings helper, which strips comments, writes atomically and validates keys against the schema.

Subcommands print the config path, dump the file with or without comments, get or set a value by dotted JSON path, unset a key to restore the app default, list every supported path, validate the file for unknown keys and open it in an editor. Values are parsed as JSON, and plain words are stored as strings. The settings sections include app, terminal, notifications, sidebar, sidebarAppearance, workspaceColors, automation, browser and shortcuts, and one reference lists all keys while another lists shortcut actions.

When your agent uses it

  • Changing a cmux preference such as appearance or sidebar behavior
  • Rebinding a cmux keyboard shortcut
  • Finding which settings keys cmux recognizes
  • Validating cmux.json for unknown keys

Example prompts

  • “Set cmux to dark appearance.”
  • “Make the cmux sidebar match the terminal background.”
  • “Rebind the new tab shortcut in cmux to ctrl+b then c.”
  • “Validate my cmux.json and tell me about any unknown keys.”

Requirements

  • The cmux app, with its settings file at ~/.config/cmux/cmux.json

Workflow steps

4 steps, taken from the first numbered list in SKILL.md.

  1. Look up the key when the user named a setting in plain English
  2. Set it. JSON literals must be valid JSON.
  3. Read back and cmux-settings validate.
  4. Tell the user it auto-reloaded, and that cmux-settings unset reverts it.

What it can do on your machine

Read from SKILL.md and the folder at commit cb7407f. It shows what the files ask for, not the result of running them.

  • Tool permissions

    Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.

    From allowed-tools in the SKILL.md frontmatter.

  • Runs code

    Ships 1 file in scripts/, which the agent can run.

    Shell commands in SKILL.md call:

    • rg

    From the folder's file list and the shell code blocks in SKILL.md.

  • Network

    Hosts in commands or code, which the agent is likely to contact:

    • raw.githubusercontent.com

    From URLs in SKILL.md, links to its own repository left out.

  • Credentials

    Names no API keys, tokens, secrets or passwords.

    From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

Context cost

cmux Settings Editor loads about 1.3k tokens when it runs, and up to ~5.5k if it reads all its reference files. Until then it costs about 109 tokens; SKILL.md has 439 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~109
When it runs · the whole SKILL.md, loaded when a task matches
~1.3k
With references · SKILL.md plus every file in references/, read only if the agent opens them
~5.5k

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Auto-check passed

The automated check found no risky patterns in SKILL.md.

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); the scripts in this folder are not scanned.

SKILL.md

The full file from basicmachines-co/basic-memory at commit cb7407f, republished under its AGPL-3.0 licence (© basicmachines-co). 439 words, ~1,260 tokens.

Download SKILL.mdSave it as .claude/skills/cmux-settings/SKILL.md (or your agent's skills folder). This skill also uses 4 other files; get the full folder from GitHub.
name
cmux-settings
description
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-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.

bash
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".

CommandWhat it does
cmux-settings pathPrint the config path.
cmux-settings dumpPrint the raw file (preserves comments).
cmux-settings dump --no-commentsPrint 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-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, 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'
  2. 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"]'
  3. Read back and cmux-settings validate.
  4. Tell the user it auto-reloaded, and that cmux-settings unset <key> reverts it.
Show full SKILL.md (182 more words)Show less

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, .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.

Full list of settings, defaults, and descriptions: cmux-settings list-supported or 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.

© basicmachines-co, AGPL-3.0. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file

Files

SKILL.md and 4 other files (scripts, references) in .agents/skills/cmux-settings of basicmachines-co/basic-memory.

  • SKILL.md
  • agents/openai.yaml
  • references/all-keys.md
  • references/shortcut-actions.md
  • scripts/cmux-settings

Open the folder on GitHubat commit cb7407f

Used in 1 other repository

We found 1 copy of this SKILL.md (exact, near-identical or edited) in other folders, from 1 other GitHub owner. This page covers the copy in basicmachines-co/basic-memory, which our catalogue first saw on October 7, 2026.

Compare with similar skills

cmux Settings Editor next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

cmux Settings Editor compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
cmux Settings Editor this skillbasicmachines-co/basic-memory4.1k1 repos~1.3kAutomated safety check: PassAGPL-3.0
Agent Browser CLIvercel-labs/agent-browser44k24 repos~864Automated safety check: PassApache-2.0
Agent ReachPanniantong/Agent-Reach93k1 repos~1.4kAutomated safety check: PassMIT
Agent Browserquran/quran.com-frontend-next1.9k42 repos~3.3kAutomated safety check: PassNone
Web Access via Browser CDPeze-is/web-access9.1k4 repos~2.2kAutomated safety check: PassMIT
Process Inboxtelegramdesktop/tdesktop33k2 repos~4.5kAutomated safety check: PassGPL-3.0

Similar skills

  • Agent Browser CLI

    vercel-labs/agent-browser

    Official

    Browser automation CLI for AI agents. Use when the user needs to interact with websites, including navigating pages, filling forms, clicking buttons, taking…

    44k GitHub starsUsed in 24 repos~864 tokens
    Productivity & AutomationAuto-check passed
  • Agent Reach

    Panniantong/Agent-Reach

    Routes web research and platform lookups across 16 sites, including Twitter, Reddit, YouTube, Bilibili, Xiaohongshu and GitHub, through one command-line tool.

    93k GitHub starsUsed in 1 repo~1.4k tokens
    Productivity & AutomationAuto-check passed
  • Agent Browser

    quran/quran.com-frontend-next

    Automates browser interactions for web testing, form filling, screenshots, and data extraction.

    1.9k GitHub starsUsed in 42 repos~3.3k tokens
    Productivity & AutomationAuto-check passed
  • Routes every web task, from searching to logged-in browsing, through a tiered choice of search, fetch, curl or a real Chrome or Edge session driven over CDP.

    9.1k GitHub starsUsed in 4 repos~2.2k tokens
    Productivity & AutomationAuto-check passed
  • Process Inbox

    telegramdesktop/tdesktop

    Process the local ignored ai-tdesktop inbox into durable, independently testable Telegram Desktop task records while task execution worktrees remain active.

    33k GitHub starsUsed in 2 repos~4.5k tokens
    Productivity & AutomationAuto-check passed
  • Dev Browser Automation

    MemTensor/MemOS

    Automates a real browser through short TypeScript scripts that keep page state between runs, for navigating, filling forms, taking screenshots and extracting data.

    12k GitHub starsUsed in 3 repos~1.7k tokens
    Productivity & AutomationAuto-check passed

More from basicmachines-co/basic-memory

All 49 skills in this repo
  • cmux Window and Pane Control

    basicmachines-co/basic-memory

    End-user control of cmux topology and routing (windows, workspaces, panes/surfaces, focus, moves, reorder, identify, trigger flash). Use when automation needs…

    4.1k GitHub starsUsed in 2 repos~842 tokens
    Auto-check passed
  • Cmux Markdown Viewer Panel

    basicmachines-co/basic-memory

    Opens markdown files in a formatted cmux panel beside the terminal that re-renders on every change, handy for plans and task lists.

    4.1k GitHub starsUsed in 2 repos~527 tokens
    Auto-check passed
  • cmux Workspace Scoping

    basicmachines-co/basic-memory

    Keeps agent actions scoped to the cmux workspace and terminal that invoked it, and lays out pane and surface commands that avoid disrupting the user's own focus.

    4.1k GitHub starsUsed in 2 repos~1.7k tokens
    Auto-check passed
  • Basic Memory Repo Images

    basicmachines-co/basic-memory

    Produces PR, changelog and two-week retro images for the Basic Memory repository from evidence in PR bodies, saved to fixed paths under docs/assets/infographics.

    4.1k GitHub stars~2.7k tokensUpdated today
    Auto-check passed
  • Logfire Instrumentation

    basicmachines-co/basic-memory

    Adds Pydantic Logfire tracing, logging and metrics to Python, JavaScript or TypeScript and Rust projects, with the correct setup order and library extras.

    4.1k GitHub stars~2.3k tokensUpdated today
    Auto-check passed
  • Basic Memory Onboarding

    basicmachines-co/basic-memory

    Guides a newcomer to Basic Memory through designing a personal knowledge system, then teaches its use and sets up their assistant to load it each session.

    4.1k GitHub stars~3.4k tokensUpdated today
    Auto-check passed

Questions about cmux Settings Editor

What does cmux Settings Editor do?

Views, sets, unsets and validates cmux settings in ~/.config/cmux/cmux.json with a helper script that checks keys against the schema. json used only as a fallback for keys that are missing. The skill requires every read and write to go through the bundled cmux-settings helper, which strips comments, writes atomically and validates keys against the schema.

When should I use cmux Settings Editor?

cmux Settings Editor fits situations like: changing a cmux preference such as appearance or sidebar behavior; rebinding a cmux keyboard shortcut; finding which settings keys cmux recognizes; validating cmux.json for unknown keys.

How do I install cmux Settings Editor in Claude Code?

Run `npx skills add basicmachines-co/basic-memory --skill cmux-settings -a claude-code`. Or copy the skill folder (.agents/skills/cmux-settings in basicmachines-co/basic-memory) into .claude/skills/cmux-settings in your project. Claude Code loads it when a task matches its description.

How do I install cmux Settings Editor in Codex?

Run `npx skills add basicmachines-co/basic-memory --skill cmux-settings -a codex`. Or copy the skill folder (.agents/skills/cmux-settings in basicmachines-co/basic-memory) into .agents/skills/cmux-settings in your project. Codex loads it when a task matches its description.

Can I use cmux Settings Editor in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add basicmachines-co/basic-memory --skill cmux-settings -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/cmux-settings, .gemini/skills/cmux-settings, .github/skills/cmux-settings and .opencode/skills/cmux-settings in your project.

What does cmux Settings Editor need to run?

Going by SKILL.md and its folder, cmux Settings Editor needs the command-line tools its instructions call (rg). Our summary lists: The cmux app, with its settings file at ~/.config/cmux/cmux.json.

Does cmux Settings Editor access the network?

SKILL.md names 1 domain. In commands or code: raw.githubusercontent.com; the agent is likely to contact it when it follows the instructions. This is read from the text; nothing was executed.

Is cmux Settings Editor safe to install?

Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. The check reads SKILL.md only: the scripts in the folder are not scanned, so read them before running anything.

What licence does cmux Settings Editor use?

cmux Settings Editor is published under the AGPL-3.0 licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does cmux Settings Editor use?

About 1.3k tokens (SKILL.md is roughly 5k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full. Its references folder adds about 4.3k tokens, read only when the agent opens those files.

What are the alternatives to cmux Settings Editor?

Skills that share tags, products or a category with cmux Settings Editor: Agent Browser CLI (vercel-labs/agent-browser, 44k stars), Agent Reach (Panniantong/Agent-Reach, 93k stars), Agent Browser (quran/quran.com-frontend-next, 1.9k stars) and Web Access via Browser CDP (eze-is/web-access, 9.1k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains cmux Settings Editor?

basicmachines-co (a GitHub organization) maintains it in basicmachines-co/basic-memory, which has 4,115 GitHub stars. The repository holds 49 skills in this directory. The repository was last updated on October 7, 2026.

Source: basicmachines-co/basic-memory on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.