Skip to content
workmux branch logoworkmux branch logoworkmux

config

Copy page

Manage the global workmux configuration file (~/.config/workmux/config.yaml).

config edit

Section titled “config edit”

Open the global configuration file in your preferred editor.

Terminal window
workmux config edit

Uses $VISUAL, then $EDITOR, then falls back to vi. If the configuration file does not exist yet, it is created with commented-out defaults before opening.

config path

Section titled “config path”

Print the path to the global configuration file. Useful for scripting.

/home/user/.config/workmux/config.yaml
workmux config path

config reference

Section titled “config reference”

Print the default configuration file with all options documented. Useful for discovering available options or piping to an AI agent for context.

Terminal window
workmux config reference

Examples

Section titled “Examples”
Terminal window
# Edit global config
workmux config edit


# Use a specific editor
EDITOR=nano workmux config edit


# Print the config path (for use in scripts)
cat "$(workmux config path)"


# Print the default config reference
workmux config reference

See also

Section titled “See also”