tmux-upterm

Share your tmux sessions securely over the internet with Upterm — perfect for pair programming and remote collaboration.

Dependencies

Required

• upterm

Installation

Add this plugin to your ~/.tmux.conf:

set -g @plugin 'tmux-contrib/tmux-upterm'

And install it by running <prefix> + I.

Usage

Key Binding	Description
Prefix + T	Create or switch to an upterm session

This plugin sets @upterm-session to true for any session created by this plugin. Use it as a boolean flag in your tmux status line:

set -g status-right '#{?@upterm-session,[upterm],}'

Configuration

Add these options to your ~/.tmux.conf:

# Change the upterm key (default: T)
set -g @upterm-key 'T'

Development

Prerequisites

Install dependencies using Nix:

nix develop

Or install manually: bash, tmux, upterm, bats

Running Tests

bats tests/

Debugging

Enable trace output with the DEBUG environment variable:

DEBUG=1 /path/to/tmux-upterm/scripts/tmux_upterm.sh

License

MIT