pmux

module
v0.0.0-...-3b85de2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 17, 2026 License: MIT

README

pmux

Plugin-based tmux session manager with web interface.

pmux = tmux + tmuxinator + ttyd + web UI

Features

  • Session Management: Create, attach, and manage tmux sessions
  • Web Terminal: Browser-based terminal via ttyd
  • Web Dashboard: Manage sessions from a web UI
  • Multi-user: Share sessions for pair programming

Installation

Prerequisites
# macOS (Homebrew)
brew install tmux tmuxinator ttyd

# Linux
apt install tmux
gem install tmuxinator
# ttyd: https://github.com/tsl0922/ttyd#installation
Install pmux
go install github.com/es6kr/pmux/cmd/pmux@latest

Or build from source:

git clone https://github.com/es6kr/pmux.git
cd pmux
make build

Usage

Check dependencies
pmux doctor
Session management
# Start a new session
pmux start dev

# List sessions
pmux list

# Attach to a session
pmux attach dev

# Stop a session
pmux stop dev
Web terminal (ttyd)
# Start web terminal for a session
pmux ttyd start dev --port 7681
# Open http://localhost:7681

# List running ttyd instances
pmux ttyd list

# Stop web terminal
pmux ttyd stop dev
Web dashboard
pmux web --port 8080
# Open http://localhost:8080

Architecture

pmux (Go)
   │
   ├── CLI commands
   │   ├── start/stop/attach/list (tmux)
   │   ├── ttyd start/stop/list
   │   └── web (dashboard)
   │
   └── Wraps existing tools
       ├── tmux (session multiplexer)
       ├── tmuxinator (session templates)
       └── ttyd (web terminal)

Development

# Install dependencies
make deps

# Generate templ files
make templ

# Build
make build

# Run with live reload
make dev

License

MIT License - see LICENSE

Directories

Path Synopsis
cmd
pmux command
internal
plugins
Package plugins imports all built-in plugins for registration
Package plugins imports all built-in plugins for registration
templ: version: v0.3.977
templ: version: v0.3.977

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL