cmux

Operate cmux terminal multiplexer panes, surfaces, and commands.

Updated Sep 1, 2024
One-click install
npx skills add https://github.com/martynovs/dotfiles --skill cmux
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: cmux
Source: https://github.com/martynovs/dotfiles/tree/main/dot_claude/skills/cmux
Command: npx skills add https://github.com/martynovs/dotfiles --skill cmux

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

cmux enables direct, on-demand control of the cmux terminal multiplexer, letting you operate panes, workspaces, and surfaces while keeping long-running tasks visible and manageable. It ensures actions inside cmux are automatically applied when in a cmux context, so you can safely run commands, read output, and manage sessions without leaving the tool.

Core Features & Use Cases

  • Create and navigate splits, panes, and surfaces to organize workspaces and keep long-running processes visible.
  • Execute commands in new splits for tasks such as builds, tests, migrations, or browser actions, while retaining context in the current surface.
  • Read screen content, send keystrokes, open a browser pane, and surface progress and notifications in the cmux UI.

Quick Start

Open a cmux session and run a command in a new split to watch its progress.

Frequently Asked Questions about cmux

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

FAQPage Schema
How do I manage terminal panes and workspaces in a cmux session?

To manage terminal panes in a cmux session, you can create and navigate splits, surfaces, and workspaces. This keeps long-running processes visible while you execute commands like builds, tests, or migrations in separate panes.

Can I read screen content and send keystrokes to a running terminal multiplexer?

Yes, you can read screen content and send keystrokes to a running terminal multiplexer using cmux commands. This enables direct, on-demand control and interaction with long-running tasks within your active workspaces.

Do I need a specific environment variable to operate cmux terminals?

Yes, operating cmux terminals requires the CMUX_WORKSPACE_ID environment variable. The system enforces environment checks to ensure safe, observable execution and proper workspace navigation when managing panes and surfaces.

Can I open a browser pane inside a terminal multiplexer workspace?

Yes, you can open a browser pane inside a terminal multiplexer workspace using cmux browser features. This allows you to perform browser actions and surface progress notifications directly within the cmux UI alongside your terminal commands.

What is the best way to keep long-running tasks visible while running other commands?

The best way to keep long-running tasks visible is to use a terminal multiplexer like cmux to create separate splits. You can execute new commands in different panes while retaining real-time visibility and context of ongoing processes in your workspace.