TUI for humans. Deterministic agent CLI for AI workflows. One interface to see, control, and automate tmux.
Project description
tmuxx
Your terminal, orchestrated. By you and your agents.
_|
_|_|_|_| _|_|_| _|_| _| _| _| _| _| _|
_| _| _| _| _| _| _|_| _|_|
_| _| _| _| _| _| _| _| _| _|
_|_| _| _| _| _|_|_| _| _| _| _|
TUI for humans. Deterministic agent CLI for AI workflows. One interface to see, control, and automate tmux.
Install
pip install tmuxx
# or, on managed systems (Debian/Ubuntu):
pipx install tmuxx
# optional Node wrapper (expects tmuxx binary in PATH):
npm install -g tmuxx
Requires Python 3.10+ and tmux.
The npm package is a thin wrapper that forwards to the tmuxx binary.
Truecolor support: If colors look off on your VM or remote server, enable truecolor:
echo 'export COLORTERM=truecolor' >> ~/.bashrc
Usage
# default: interactive TUI with pane activity indicators
tmuxx
# explicit TUI mode
tmuxx tui
# deterministic agent automation mode
tmuxx agent --help
# binary version
tmuxx --version
TUI Features
The interactive TUI displays pane-level activity status with color-rendered preview:
▶= running (blue) — agent actively processing⏸= waiting (red) — agent blocked on permission/input⎇= worktree (green) — 4th-level tree node showing git worktree branch
Header legend shows all status indicators at a glance. Preview panel renders full ANSI terminal colors.
Keybindings
| Key | Action |
|---|---|
n |
New session |
w |
New window |
h |
Split pane horizontally |
v |
Split pane vertically |
k |
Kill selected session/window/pane |
r |
Rename session or window |
s |
Activate selected window/pane |
a |
Attach to session |
y |
Yank (copy) preview to clipboard |
b |
Toggle sidebar |
? |
Show help menu |
R |
Force refresh |
+ / - |
Resize pane up/down |
[ / ] |
Resize pane left/right |
q |
Quit |
Agent Orchestration
Run parallel AI agents in isolated git worktrees, each with its own branch and tmux window. Monitor all agents with pane-level activity visibility — see which ones are running, idle, or blocked on user input.
Deterministic Workflow Commands
tmuxx agent start-task <session_name> "<prompt>" [--branch ...] [--base-branch ...] [--agent-command ...]
tmuxx agent task-report <branch>
tmuxx agent complete-task <branch> [--test-command ...] [--commit-message ...]
tmuxx agent abort-task <branch>
Recommended command flow for skills:
start-taskcreates worktree + tmux window and runs the agent command.task-reportprovides branch status, diff, and log presence with stable fields.complete-taskorabort-taskperforms capture + cleanup in one operation.
JSON-first Mode
All tmuxx agent commands support --json for machine-safe parsing:
tmuxx agent list-worktrees --json
tmuxx agent start-task dev "fix login bug" --json
tmuxx agent task-report fix-login-bug --json
tmuxx agent complete-task fix-login-bug --test-command "pytest -q" --json
run-and-capture is scoped to the command you send (it returns command-local output, not full pane scrollback).
Full Command Surface
# introspection
tmuxx agent list-sessions
tmuxx agent capture-pane %1 --lines 200
tmuxx agent capture-window @2
tmuxx agent screenshot-window @2 --output ./window.png
# session/window/pane operations
tmuxx agent create-session dev
tmuxx agent create-window dev --name logs
tmuxx agent split-pane %3 --horizontal
tmuxx agent send-command %3 -- npm test
tmuxx agent send-text %3 -- "draft note in shell"
tmuxx agent send-keys %3 C-c
tmuxx agent send-keys %3 --literal -- "echo hello"
tmuxx agent run-and-capture %3 --wait-seconds 2 --lines 300 -- pytest -q
# worktree operations
tmuxx agent launch-agent dev "add auth tests" --base-branch feat-auth
tmuxx agent list-worktrees
tmuxx agent diff-worktree feat-auth-tests
tmuxx agent merge-worktree feat-auth-tests --test-command "pytest -q"
tmuxx agent discard-worktree feat-auth-tests
tmuxx agent read-agent-log feat-auth-tests
Legacy MCP Compatibility (Optional)
tmuxx is now single-binary first. If you still need MCP for external clients, the legacy module remains in source.
pip install "tmuxx[mcp]"
python tmux_mcp.py
License
MIT
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file tmuxx-0.3.11.tar.gz.
File metadata
- Download URL: tmuxx-0.3.11.tar.gz
- Upload date:
- Size: 36.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.14.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
d30fa4f9d65174928a1780ee402b16b00478f84214dc58da00358abca6a4d8b4
|
|
| MD5 |
ffda78c18ab8afd4a9fccf024361bfb9
|
|
| BLAKE2b-256 |
ad3e9a348249a36926c66524dd23943d7835fddc7575102fd021deb74ba20f03
|
File details
Details for the file tmuxx-0.3.11-py3-none-any.whl.
File metadata
- Download URL: tmuxx-0.3.11-py3-none-any.whl
- Upload date:
- Size: 36.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.14.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
6e5be44aba5970f1ec596bb24cfd763c072717188e8567f87d6ec5fe5d5745d8
|
|
| MD5 |
131e5cd5ff8bb3f987ca5942015af917
|
|
| BLAKE2b-256 |
ee20914afc9f7e3ae47988ff0e58a30aa8745da598711052a4348eb53a3e03e0
|