manaflow-ai/cmux

CMUX Architecture defines the cmux package structure, layering model, dependency inversion, and Swift 6 concurrency rules. Use it before adding or meaningfully rewriting Swift files, packages, coordinators, services, repositories, or public package APIs.

CMUX Billing is a runbook for editing and debugging cmux billing code, covering Stripe checkout, pricing, subscriptions, webhooks, and Pro entitlement.

CMUX Shared Behavior enforces a single shared action and mutation path across all entrypoints (shortcuts, command palette, context menu, CLI, settings, debug menu) with consistent optimistic updates and rollback; use it when adding entrypoints or when tests missed a bug.

CMux Debugging instruments debug events, provides a Debug menu, and avoids runtime pitfalls in the cmux terminal multiplexer. Use it when adding debug probes, diagnosing UI/runtime issues, or touching terminal rendering and list views.

CMux Release manages the cmux release workflow, including version bumping, changelog updates, pretag guard, release tags, and asset expectations. Use it when preparing or troubleshooting a cmux release.

Cmux controls the topology and routing of a multi-pane terminal layout, including windows, workspaces, panes, surfaces, focus, moves, reorder, identify, and trigger flash. Use it when automation needs deterministic placement and navigation in a cmux environment.

Cmux Backend provides backend TypeScript and Cloud VM development rules for cmux, covering Effect services, Postgres migrations, provider integrations, auth pricing gates, and VM lifecycle workflows. Use it when editing backend code or VM lifecycle logic.

Cmux Browser opens sites, interacts with pages, waits for state changes, and extracts data from cmux browser surfaces. Use it when you need end-user browser automation through the cmux command-line interface.

Cmux Custom Sidebar builds a custom cmux sidebar from a plain-language request. It writes a hot-reloading SwiftUI-style file that binds to live workspaces, tabs, PRs, and clock data, and runs cmux commands on tap.

Cmux Customization customizes cmux for an end user by editing cmux.json, dock.json, and Ghostty config to set actions, commands, layouts, buttons, shortcuts, notifications, and app preferences. Use it when changing cmux behavior, interface elements, or terminal settings.

Cmux Keyboard Shortcuts customizes key bindings for the cmux terminal multiplexer using presets or explicit rebinds. Use it when the user asks to rebind, unbind, reset, audit, or create shortcut templates.

Cmux Markdown opens markdown files in a formatted viewer panel with live reload. Use it to display plans, documentation, or notes alongside the terminal with rich rendering of headings, code blocks, tables, and lists.

Cmux Settings lets you view and edit cmux settings in ~/.config/cmux/cmux.json, including appearance, sidebar, notifications, automation, browser, and shortcuts. Use it to set values by JSON path, validate the file, open it in an editor, or look up which keys cmux recognizes.

Cmux Socket Policy defines threading and focus rules for cmux socket and CLI commands to keep telemetry off the main thread and prevent commands from stealing macOS app focus.

cmux Dev Workflow provides contributor rules for setting up the cmux repository, normalizing Xcode project files, developing tagged sidebar extensions, and creating dev builds. Use it when configuring the project, editing .xcodeproj files, adding sidebar extensions, or working with tagged debug builds.

cmux Diagnostics runs read-only checks to diagnose cmux CLI, socket, settings, hook, session restore, and notification issues. Use it when cmux hooks, agent resume, or notifications are not working, or when asking for a health check or support-safe debug summary.

cmux Ghostty provides workflow rules for the Ghostty submodule and GhosttyKit builds in the cmux project. Use it when modifying the ghostty submodule, rebuilding GhosttyKit.xcframework, updating the parent submodule pointer, or documenting fork conflict notes.

cmux Localization defines hard rules and an audit checklist for localizing every user-facing string in cmux, including UI, Settings, menus, docs, and web messages. Use it whenever changing user-facing text to ensure all locales are covered and no bare English slips through.

cmux Testing defines Swift Testing rules for cmux and validates test target compilation and test wiring. Use when adding or changing tests, touching package/refactor code, or deciding whether reload.sh is enough validation.

cmux Workspace scopes agent actions to the current cmux workspace, panes, surfaces, and sidebar state, enabling non-interfering terminal automation. Use it when working inside cmux to manage layout, send commands to specific surfaces, and update workspace status without changing user focus.