Reference Reference
muxie CLI
The muxie command-line interface for driving Muxie from inside a pane — notifications, agent state, spawning panes, and orchestration.
The muxie CLI talks to a running Muxie over a socket (MUXIE_SOCK). Most commands act on a session resolved from the --session flag or the MUXIE_SESSION_ID environment variable that Muxie sets in each pane.
Shell integration & hooks
| Command | Purpose |
|---|---|
muxie shell-integration <bash|zsh> | Print a shell-integration line to eval (POSIX shells only). |
muxie hooks setup <claude|codex|aider|gemini|cursor-agent|opencode|amp|droid|all> | Install an agent’s lifecycle hooks. |
muxie hooks <agent> <event> | Dispatch an agent lifecycle event (reads JSON on stdin for Claude); drives sidebar attention state. |
Control messages (one-way)
All accept --session ID.
| Command | Purpose |
|---|---|
muxie notify --title TEXT [--body TEXT] | Send a notification. |
muxie event --kind {running|idle|needsInput|done} | Report agent run state. |
muxie set-status TEXT | Set the agent status pill. |
muxie clear-status | Clear the agent status pill. |
muxie set-progress PERCENT [--label TEXT] | Show a progress bar. |
muxie clear-progress | Clear the progress bar. |
muxie log TEXT | Emit an agent log line. |
muxie send TEXT | Send raw text to the PTY. |
muxie send-key KEY | Send a named key. |
muxie new-split {right|down} | Split the session’s pane. |
muxie report-pwd PATH | Report the working directory (shell-integration helper). |
muxie report-git-branch BRANCH [--status dirty|clean] | Report the git branch and status. |
muxie report-ports PORT… | Report open ports. |
muxie report-tty PATH | Report the TTY path. |
muxie report-shell-state {prompt|running} | Report shell state. |
muxie ports-kick | Trigger a port-table refresh. |
Blocking request/response
These print their result to stdout.
| Command | Purpose |
|---|---|
muxie feed request --kind {permission|plan|question} --title TEXT [--body TEXT] --option ID=LABEL … [--danger ID] | Ask the user and return the chosen option id. |
muxie api pane.list [--target SESSION] | List panes. |
muxie api pane.read [--target SESSION] [--lines N] | Read a pane’s buffer. |
muxie api wait.agentState --state {working|blocked|idle} [--target SESSION] [--timeout MS] | Block until an agent reaches a state. |
muxie api wait.output --match REGEX [--target SESSION] [--timeout MS] | Block until output matches. |
muxie spawn [right|down] COMMAND [--prompt TEXT] [--cwd DIR] | Spawn a new pane; prints the new session id. |
muxie browser automate [--url URL] | Request a CDP-wired browser pane; prints the CDP endpoint. |
muxie browser {navigate|reload|back|forward} [URL] [--pane PANEID] | Control a browser pane. |
muxie focus-pane {left|right|up|down} | Move pane focus. |
Note: These commands require running inside a Muxie pane (so
MUXIE_SOCKis set). See Agent awareness.