Skip to content

config

Copy page

Manage the global workrex configuration file (~/.config/workrex/config.yaml). Configuration and state live under Workrex-owned paths. See Configuration.

Open the global configuration file in your preferred editor.

Terminal window
workrex 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.

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

/home/user/.config/workrex/config.yaml
workrex config path

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

Terminal window
workrex config reference
Terminal window
# Edit global config
workrex config edit
# Use a specific editor
EDITOR=nano workrex config edit
# Print the config path (for use in scripts)
cat "$(workrex config path)"
# Print the default config reference
workrex config reference