Reference

upterm-config(1)

Manage upterm configuration

NAME

upterm-config - Manage upterm configuration

SYNOPSIS

upterm config [command]

DESCRIPTION

Manage upterm's config file: YAML, with flags' names as its keys, e.g. hide-client-ip: true.

Config file: /build/.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:
1. The command line
2. An environment variable: UPTERM_ and the flag's name in capitals, with
_ for -, e.g. UPTERM_HIDE_CLIENT_IP=true for --hide-client-ip
3. The config file
4. The flag's default

These flags take values only from the command line:
--output on host, session info, session current, session list and version
--name and --detach on host
--join-timeout on session set
--wait on join Host's --join-timeout still reads env and config.

OPTIONS

-h, --help[=false]
help for config

OPTIONS INHERITED FROM PARENT COMMANDS

--debug[=false]
Enable debug logging (log file: /build/.upterm/upterm.log). A non-empty DEBUG turns it on too.

SEE ALSO

upterm(1), upterm-config-edit(1), upterm-config-path(1), upterm-config-view(1)

HISTORY

27-Oct-2026 Auto generated by spf13/cobra