Manage upterm configuration
Manage upterm's config file: YAML, with flags' names as its keys, e.g. hide-client-ip: true.
Config file: /home/user/.config/upterm/config.yaml
That is usually ~/.config/upterm/config.yaml on Linux, ~/Library/Application Support/upterm/config.yaml on macOS and %LOCALAPPDATA%\upterm\config.yaml on Windows, or $XDG_CONFIG_HOME/upterm/config.yaml when XDG_CONFIG_HOME is set.
A flag's value comes from the first of these that sets it:
- The command line
- An environment variable: UPTERM_ and the flag's name in capitals, with _ for -, e.g. UPTERM_HIDE_CLIENT_IP=true for --hide-client-ip
- The config file
- The flag's default
These flags take values only from the command line: host: --login-command, --allow-exec, --no-exec, --allow-sftp, --allow-forwarding, --no-forwarding, --full-access, --name, --detach, --output join: --wait session current: --output session info: --output session list: --output session set: --join-timeout session ssh-config: --alias version: --output Host's --join-timeout still reads env and config.
-h, --help help for config
--debug Enable debug logging (log file: /home/user/.local/state/upterm/upterm.log). A non-empty DEBUG turns it on too.
- upterm - Instant Terminal Sharing
- upterm config edit - Edit the config file
- upterm config path - Show the path to the config file
- upterm config view - View the config file contents