Skip to content

auberge config

Manage user configuration

Terminal window
auberge config <COMMAND>
# Alias: auberge c
Command Alias Description
init i Print a config.toml scaffold derived from the Key Registry
set s Set a config value
get g Get a config value
list l List all config keys (sensitive values redacted)
remove rm Remove a key from config
edit e Open config in $EDITOR
path p Print config file path
Flag Description
--playbooks <a,b,c> Emit only keys in the union of the named Playbook Metas’ required_keys
--output, -o <path> Write the scaffold to a file (refuses to overwrite without --force)
--force, -f Overwrite the output file if it exists
Flag Description
--resolved Execute !-prefixed command references and print the resolved value (may print secrets)

By default get prints the raw stored value — a key stored as !pa show foo prints that literal string. With --resolved, the reference is executed exactly as deploy resolves it (!! escapes to a literal !, output is whitespace-trimmed, and a failing or empty command exits non-zero without printing the raw value).

When key is omitted from set, get, or remove, an interactive fuzzy-search selector appears (requires a TTY). For set, the value is also prompted interactively if omitted.

In non-interactive mode (pipes, scripts), a key argument is required for get and remove, and both key and value are required for set.

Terminal window
# Print full scaffold to stdout
auberge config init
# Generate config.toml at the XDG config path
auberge config init --output "$(auberge config path)"
# Scope the scaffold to specific playbooks
auberge config init --playbooks paperless,navidrome
# Overwrite an existing file
auberge config init --output config.toml --force
# Set a value directly
auberge c s admin_user_name myuser
# Withdraw a fleet-wide answer for one host (see Host-scoped Config)
auberge c s hosts.ruche.headscale_subdomain ""
# Set interactively (select key, then type value)
auberge c s
# List all keys
auberge c l
# Get a specific value
auberge c g domain
# Resolve a !-command reference (prints the secret, not the ref)
auberge c g restic_password --resolved
# Get interactively (select key from list)
auberge c g
# Remove interactively
auberge c rm
# Edit in your editor
auberge c e

Use auberge config --help for full options.