upterm
Instant Terminal Sharing
Synopsis
Upterm is an open-source solution for sharing terminal sessions instantly over secure SSH tunnels to the public internet.
Configuration Priority (highest to lowest):
- Command-line flags
- Environment variables (UPTERM_ prefix)
- Config file (see below)
- Default values
Config File: ~/.config/upterm/config.yaml (Linux) ~/Library/Application Support/upterm/config.yaml (macOS) %LOCALAPPDATA%\upterm\config.yaml (Windows)
Run ‘upterm config path’ to see your config file location. Run ‘upterm config edit’ to create and edit the config file.
Environment Variables: All flags can be set via environment variables with the UPTERM_ prefix. Flag names are converted by replacing hyphens (-) with underscores (_).
Examples: –hide-client-ip → UPTERM_HIDE_CLIENT_IP=true –read-only → UPTERM_READ_ONLY=true –accept → UPTERM_ACCEPT=true
Examples
# Host a terminal session running $SHELL, attaching client's IO to the host's:
$ upterm host
# Display the SSH connection string for sharing with client(s):
$ upterm session current
=== SESSION_ID
Command: /bin/bash
Force Command: n/a
Host: ssh://uptermd.upterm.dev:22
SSH Session: ssh [email protected]
# A client connects to the host session via SSH:
$ ssh [email protected]
# Set flags via environment variables:
$ UPTERM_HIDE_CLIENT_IP=true upterm host
Options
--debug enable debug level logging (log file: /home/user/.local/state/upterm/upterm.log).
-h, --help help for upterm
SEE ALSO
- upterm config - Manage upterm configuration
- upterm host - Host a terminal session
- upterm proxy - Proxy a terminal session via WebSocket
- upterm session - Display and manage terminal sessions
- upterm upgrade - Upgrade the CLI
- upterm version - Show version