UPTERM(1)

📦
version 0.41.0 · 2 versions
, in arch rolling

🎀 NAME 🎀

okay bestie, welcome to the UPTERM(1) page from the Upterm Manual — and this one is literally upterm-config: Manage upterm configuration. That’s the whole assignment, and it’s lowkey iconic. 💅

🦋 SYNOPSIS 🦋

upterm config [command]

🌸 DESCRIPTION 🌸

You’re managing upterm’s config file, and it’s YAML, with the flags’ names as its keys — e.g. hide-client-ip: true. Slay.

The config file lives at /build/.config/upterm/config.yaml. Usually that lands at:

  • ~/.config/upterm/config.yaml on Linux
  • ~/Library/Application Support/upterm/config.yaml on macOS
  • %LOCALAPPDATA%\upterm\config.yaml on Windows
  • $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 — CLI main character energy only, periodt:

  • --output on host, session info, session current, session list and version
  • --name and --detach on host
  • --login-command, --allow-exec, --allow-sftp, --allow-forwarding, --full-access, --no-exec and --no-forwarding on host
  • --join-timeout on session set
  • --wait on join

Plot twist: Host’s --join-timeout still reads env and config. iykyk 🫶

💖 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 🦋

your next reads, bestie: upterm(1), upterm-config-edit(1), upterm-config-path(1), upterm-config-view(1)

🌈 HISTORY 🌈

2-Nov-2026 — Auto generated by spf13/cobra

and that’s the vibe! this page is from Upterm 0.0.0+dev, dated Nov 2026, and it’s the UPTERM(1) manual — mwah 💋✨

📦 where this page comes from