---
name: "upterm-config-edit"
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-edit"
---

# upterm-config-edit(1)

Edit the config file

## NAME

upterm-config-edit - Edit the config file

## SYNOPSIS

**upterm config edit \[flags\]**

## DESCRIPTION

Open the config file in your editor, first creating it, and its directory, from the example when there is none.

Config file: /build/.config/upterm/config.yaml

The editor is $VISUAL, else $EDITOR, else nano (vi without nano; notepad on Windows). A value that names an existing file runs as it is; any other is split into a program and its arguments (code --wait), as a POSIX shell would on Unix and by the Windows command-line rules on Windows.

Once the editor exits, the file is checked as commands read it: its YAML, its keys, and each value as the command it belongs to would check it. Each problem is one upterm: line, and the exit status is 1. When the editor itself exits with an error, the file isn't checked.

Exit status: 0, or 1 on failure.

## OPTIONS

**-h**, **--help**\[=false\]\
 	help for edit

## OPTIONS INHERITED FROM PARENT COMMANDS

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

## EXAMPLE

```
  # Edit the config file:
  upterm config edit
  # With an editor that needs an argument to wait:
  VISUAL='code --wait' upterm config edit
```

## SEE ALSO

**[upterm-config(1)](/upterm-config/1.md)**

## HISTORY

27-Oct-2026 Auto generated by spf13/cobra