Prerequisites
- cmux installed (see Installation)
- Basic familiarity with terminal commands
Launch cmux
Open cmux from your Applications folder or via Spotlight (Cmd+Space, type “cmux”).
On first launch, you’ll see a single workspace with a terminal. The sidebar on the left shows your workspace tabs.
Create a workspace
Workspaces are the top-level organizing unit in cmux. Each workspace can contain multiple split panes and surfaces (terminals and browsers).Create a new workspace
Press You can also create a workspace in a specific directory:
Cmd+N or use the CLI:Navigate between workspaces
Use keyboard shortcuts to switch workspaces:
| Shortcut | Action |
|---|---|
Cmd+1–8 | Jump to workspace 1–8 |
Cmd+9 | Jump to last workspace |
Ctrl+Cmd+] | Next workspace |
Ctrl+Cmd+[ | Previous workspace |
Split panes
Split your workspace horizontally or vertically to work with multiple terminals side-by-side.
You can also split panes via CLI:
Set up notifications
Notifications are cmux’s killer feature for working with AI coding agents. When an agent needs your attention, its pane gets a blue ring and the tab lights up.Send a test notification
- A blue ring around the current pane
- The workspace tab glows in the sidebar
- The notification appears in the notification panel
Terminal notification sequences
cmux also picks up standard terminal notification sequences (OSC 9/99/777):Use the in-app browser
The in-app browser lets you view and automate web pages alongside your terminal.Scriptable browser API
The browser has a scriptable API ported from agent-browser for automation:Integrate with AI coding agents
cmux is designed to work seamlessly with AI coding tools. Here’s how to integrate with popular agents:Claude Code
cmux has built-in Claude Code integration. To enable it:Set up the hook
cmux can automatically notify you when Claude Code is waiting. The integration is enabled by default in recent versions.When Claude Code pauses for input, you’ll see a notification in the workspace where it’s running.
OpenCode
For OpenCode or other agents, use thecmux notify command in your shell prompts or agent hooks:
Custom integrations
You can wirecmux notify into any tool that supports custom commands or hooks:
Keyboard shortcuts reference
Here are the essential shortcuts to get started:Workspaces
| Shortcut | Action |
|---|---|
Cmd+N | New workspace |
Cmd+1–8 | Jump to workspace 1–8 |
Cmd+9 | Jump to last workspace |
Ctrl+Cmd+] | Next workspace |
Ctrl+Cmd+[ | Previous workspace |
Cmd+Shift+W | Close workspace |
Cmd+Shift+R | Rename workspace |
Cmd+B | Toggle sidebar |
Split panes
| Shortcut | Action |
|---|---|
Cmd+D | Split right |
Cmd+Shift+D | Split down |
Opt+Cmd+Arrow | Focus pane directionally |
Cmd+Shift+H | Flash focused panel |
Notifications
| Shortcut | Action |
|---|---|
Cmd+I | Show notifications panel |
Cmd+Shift+U | Jump to latest unread |
Browser
| Shortcut | Action |
|---|---|
Cmd+Shift+L | Open browser in split |
Cmd+L | Focus address bar |
Cmd+[ | Back |
Cmd+] | Forward |
Cmd+R | Reload page |
Next steps
Workspaces & Tabs
Learn advanced workspace management
Notifications
Master the notification system
CLI Reference
Explore all CLI commands
Browser Automation
Automate the in-app browser