.nh
.TH "UPTERM" "1" "Jan 2026" "Upterm 0.0.0+dev" "Upterm Manual"

.SH NAME
upterm - Instant Terminal Sharing


.SH SYNOPSIS
\fBupterm [flags]\fP


.SH DESCRIPTION
Upterm is an open-source solution for sharing terminal sessions instantly over secure SSH tunnels to the public internet.

.PP
Configuration Priority (highest to lowest):
  1. Command-line flags
  2. Environment variables (UPTERM_ prefix)
  3. Config file (see below)
  4. Default values

.PP
Config File:
  ~/.config/upterm/config.yaml (Linux)
  ~/Library/Application Support/upterm/config.yaml (macOS)
  %LOCALAPPDATA%\\upterm\\config.yaml (Windows)

.PP
Run 'upterm config path' to see your config file location.
  Run 'upterm config edit' to create and edit the config file.

.PP
Environment Variables:
  All flags can be set via environment variables with the UPTERM_ prefix.
  Flag names are converted by replacing hyphens (-) with underscores (_).

.PP
Examples:
    --hide-client-ip  → UPTERM_HIDE_CLIENT_IP=true
    --read-only       → UPTERM_READ_ONLY=true
    --accept          → UPTERM_ACCEPT=true


.SH OPTIONS
\fB--debug\fP[=false]
	enable debug level logging (log file: /build/.upterm/upterm.log).

.PP
\fB-h\fP, \fB--help\fP[=false]
	help for upterm


.SH EXAMPLE
.EX
  # 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 TOKEN@uptermd.upterm.dev

  # A client connects to the host session via SSH:
  $ ssh TOKEN@uptermd.upterm.dev

  # Set flags via environment variables:
  $ UPTERM_HIDE_CLIENT_IP=true upterm host
.EE


.SH SEE ALSO
\fBupterm-config(1)\fP, \fBupterm-host(1)\fP, \fBupterm-proxy(1)\fP, \fBupterm-session(1)\fP, \fBupterm-upgrade(1)\fP, \fBupterm-version(1)\fP


.SH HISTORY
14-Jan-2026 Auto generated by spf13/cobra