Skip to main content

Race-condition-safe tmux wrapper for coding agents

Project description

twmux logo

Race-condition-safe tmux wrapper for coding agents.

Features

  • Agent isolation - Default socket claude keeps agent operations separate from user tmux
  • Safety boundaries - Non-agent sockets require --force flag
  • Session lifecycle - Create, monitor, and clean up sessions easily
  • Race-condition-safe send - Verifies commands are received before sending Enter
  • Execute and capture - Run commands and get output with exit codes
  • Marker-based execution - Reliable output capture using unique markers
  • Wait-idle detection - Wait until pane output stabilizes
  • JSON output - Programmatic interface for all commands
  • Flexible targeting - Pane IDs or session:window.pane syntax
  • Pane management - Launch, kill, interrupt, and escape

Nothing you couldn't do with bare "tmux" skill, but much more reliable with agent use.

Agent Isolation

By default, twmux operates on the claude socket, keeping agent tmux sessions separate from your personal tmux:

# Agent operations (default socket: claude)
twmux new myapp
twmux send -t %0 "echo hello"
twmux status

# User can monitor without interference
tmux -L claude attach -t myapp   # Watch agent work
# Ctrl+b d to detach

# Access user's tmux requires explicit --force
twmux -L default --force status  # View user's default socket

Socket naming:

  • claude, claude-* - Agent sockets (no --force needed)
  • All other names - Require --force flag

Installation

uv pip install -e .

Usage

twmux [OPTIONS] COMMAND [ARGS]

Global Options

Option Description
--json Output as JSON (for programmatic use)
-L, --socket NAME tmux socket name (default: claude)
--force Allow non-agent sockets (required for non-claude* sockets)
-v, --verbose Verbose output

Commands

send - Send text safely

Send text to a pane with race-condition-safe Enter handling.

twmux send -t %5 "echo hello"
twmux send -t main:0.1 "make test" --delay 0.1
twmux send -t %5 "partial text" --no-enter

exec - Execute and capture

Execute a command and capture output with exit code.

twmux exec -t %5 "ls -la"
twmux --json exec -t main:0 "make test" --timeout 60

Returns:

  • output: Command stdout/stderr
  • exit_code: Command exit code (-1 if timeout)
  • timed_out: Whether command timed out

capture - Capture pane content

twmux capture -t %5
twmux capture -t %5 -n 50  # Last 50 lines
twmux --json capture -t main:0

wait-idle - Wait for output stabilization

Wait until pane output stops changing.

twmux wait-idle -t %5
twmux wait-idle -t %5 --timeout 10 --interval 0.1

interrupt - Send Ctrl+C

twmux interrupt -t %5

escape - Send Escape key

twmux escape -t %5

launch - Create new pane

Split current pane to create a new one.

twmux launch -t %5                      # Split below
twmux launch -t %5 -v                   # Split right (vertical)
twmux launch -t %5 -c "python3"         # Split and run command

kill - Kill pane

twmux kill -t %5

new - Create session

Create a new tmux session on the agent socket. Prints monitor command for user observation.

twmux new myapp                    # Create session "myapp"
twmux new myapp -c "python3"       # Create and run command
twmux -L claude-isolated new test  # Use different agent socket

Output includes monitor command:

Session created: myapp on socket claude
Pane ID: %0

To monitor:  tmux -L claude attach -t myapp
To detach:   Ctrl+b d

kill-session - Kill session

twmux kill-session myapp

kill-server - Kill server

Kill the entire tmux server for a socket.

twmux kill-server                    # Kill default claude server
twmux -L claude-isolated kill-server # Kill specific socket

status - Show tmux state

twmux status              # Show default socket (claude)
twmux status --all        # Show all agent sockets (claude*)
twmux status --all --force  # Show all sockets including user's

Target Addressing

The -t option accepts tmux target syntax to identify panes.

Pane ID (Recommended)

Direct pane reference using tmux pane ID:

twmux send -t %5 "echo hello"      # Pane ID %5
twmux exec -t %12 "ls"             # Pane ID %12

Get pane IDs with twmux status or tmux list-panes -a.

Session:Window.Pane Format

Hierarchical addressing:

# Full path: session:window.pane
twmux send -t main:0.1 "echo hello"    # Session "main", window 0, pane 1
twmux send -t dev:2.0 "make test"      # Session "dev", window 2, pane 0

# Partial paths
twmux send -t main:0 "echo hello"      # Session "main", window 0, active pane
twmux send -t main: "echo hello"       # Session "main", active window/pane
twmux send -t :0.1 "echo hello"        # First session, window 0, pane 1

Target Resolution

Target Meaning
%5 Pane with ID %5 (absolute)
main:0.1 Session "main", window 0, pane 1
main:0 Session "main", window 0, active pane
main: Session "main", active window and pane
:0.1 First session, window 0, pane 1
:0 First session, window 0, active pane
(empty) First session, active window and pane

Examples

# Start a REPL in a new pane and interact with it
twmux launch -t %5 -c "python3"
# Returns: {"pane_id": "%12"}

# Send commands to the new pane
twmux send -t %12 "print('hello')"
twmux wait-idle -t %12

# Capture output
twmux capture -t %12 -n 10

# Execute and get result
twmux --json exec -t %12 "print(1+1)"
# Returns: {"output": "2", "exit_code": 0, "timed_out": false}

# Clean up
twmux kill -t %12

JSON Output

All commands support --json for programmatic use:

$ twmux --json exec -t %5 "echo hello"
{"output": "hello", "exit_code": 0, "timed_out": false}

$ twmux --json send -t %5 "test"
{"success": true, "attempts": 1}

$ twmux --json new myapp
{"session": "myapp", "socket": "claude", "pane_id": "%0", "monitor_cmd": "tmux -L claude attach -t myapp"}

$ twmux --json status
{
  "sockets": [
    {
      "socket": "claude",
      "sessions": [
        {
          "session_id": "$0",
          "session_name": "myapp",
          "windows": [...]
        }
      ]
    }
  ]
}

How It Works

Race-Condition-Safe Send

The send command:

  1. Sends text without Enter
  2. Waits (configurable delay)
  3. Captures pane content
  4. Sends Enter
  5. Verifies content changed
  6. Retries if needed

Marker-Based Execution

The exec command:

  1. Generates unique markers
  2. Wraps command: echo START; { cmd; } 2>&1; echo END:$?
  3. Polls pane with progressive expansion (100 → 500 → 2000 → all lines)
  4. Parses output between markers
  5. Extracts exit code

Output Stabilization

The wait-idle command:

  1. Hashes pane content (MD5)
  2. Polls at configurable interval
  3. Returns when N consecutive hashes match
  4. Times out if content keeps changing

Development

make install   # Install dependencies
make test      # Run tests
make lint      # Check code style
make format    # Auto-format code
make check     # Run lint + test

License

MIT

Prior Art, Inspiration

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

twmux-0.2.0.tar.gz (14.3 kB view details)

Uploaded Source

Built Distribution

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

twmux-0.2.0-py3-none-any.whl (13.1 kB view details)

Uploaded Python 3

File details

Details for the file twmux-0.2.0.tar.gz.

File metadata

  • Download URL: twmux-0.2.0.tar.gz
  • Upload date:
  • Size: 14.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.11

File hashes

Hashes for twmux-0.2.0.tar.gz
Algorithm Hash digest
SHA256 cb86138e8e86f0a10b6fd7b57615f2f5e765773cbfe4cb54980f2371b92914fa
MD5 72d67aaec56ca57e696c16b5ff403d49
BLAKE2b-256 80e11a85ca4b2631a4f083f7e5693dc534354c62972c85a6d83a4054ce585a2b

See more details on using hashes here.

File details

Details for the file twmux-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: twmux-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 13.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.11

File hashes

Hashes for twmux-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 73b910bdd28354b94b26190a03e8578dbe0e31a5f177b98af310030bc0596011
MD5 4d7a3c5d1bd3d58f367d2c1fd1649c1c
BLAKE2b-256 56dafab0fc249332fe3bc5a713d31958c724025ae3a9c5712b0982943842053a

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