Skip to main content

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.

Usage

# default: interactive TUI
tmuxx

# explicit TUI mode
tmuxx tui

# deterministic agent automation mode
tmuxx agent --help

# binary version
tmuxx --version

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:

  1. start-task creates worktree + tmux window and runs the agent command.
  2. task-report provides branch status, diff, and log presence with stable fields.
  3. complete-task or abort-task performs 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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

tmuxx-0.3.7.tar.gz (34.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

tmuxx-0.3.7-py3-none-any.whl (34.7 kB view details)

Uploaded Python 3

File details

Details for the file tmuxx-0.3.7.tar.gz.

File metadata

  • Download URL: tmuxx-0.3.7.tar.gz
  • Upload date:
  • Size: 34.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.3

File hashes

Hashes for tmuxx-0.3.7.tar.gz
Algorithm Hash digest
SHA256 3d4d34b88645d6401060c213070c2bfc743f8f0d4193fe2122375e596b684584
MD5 7dacb681fe81d0aa28afbaf7dabc1a62
BLAKE2b-256 1f031d528857b925e7fadb3b5285ddcf1b71adee285addda70cb570679529f7c

See more details on using hashes here.

File details

Details for the file tmuxx-0.3.7-py3-none-any.whl.

File metadata

  • Download URL: tmuxx-0.3.7-py3-none-any.whl
  • Upload date:
  • Size: 34.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.3

File hashes

Hashes for tmuxx-0.3.7-py3-none-any.whl
Algorithm Hash digest
SHA256 d6ee535b3c4c15eb70c487f23b89dcec0a2df9b3f43a006bbd5dabd4019d15fa
MD5 5f11a3f39f22b8df69eace8bb399b398
BLAKE2b-256 4be1d59930833617a365e889efcf021e6996e17b27b022976388a2f11a4a6c3c

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page