---
name: "upterm-config"
section: "1"
platform: "linux"
package: "upterm"
version: "0.40.0-1"
release: "Arch Linux 2026-11-01"
platforms: ["linux"]
url: "https://new.carta.tech/upterm-config"
---

# 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/1.md)**, **[upterm-config-edit(1)](/upterm-config-edit/1.md)**, **[upterm-config-path(1)](/upterm-config-path/1.md)**, **[upterm-config-view(1)](/upterm-config-view/1.md)**

## HISTORY

27-Oct-2026 Auto generated by spf13/cobra