Skip to content

title: rledger config description: Manage rustledger configuration

rledger config

Manage rustledger configuration files and settings.

Usage

bash
rledger config <COMMAND>

Commands

CommandDescription
showShow the merged configuration from all sources
pathShow config file search paths
editOpen config file in editor
initGenerate a default config file
aliasesList configured aliases

Options

OptionDescription
-P, --profile <PROFILE>Use a specific profile from config

Examples

Show Current Config

bash
rledger config show

Output:

toml
# Merged configuration (highest priority wins)
# Sources: user > system

[default]
file = "/home/user/finances/main.beancount"

[output]
format = "text"

Show Config Paths

bash
rledger config path

Output:

Configuration file search paths:

  project  (not found)  /home/user/finances/.rledger.toml
  user     (found)      /home/user/.config/rledger/config.toml
  system   (not found)  /etc/rledger/config.toml

Environment variables:
  RLEDGER_FILE     Default beancount file
  RLEDGER_FORMAT   Output format (text, csv, json)
  RLEDGER_PROFILE  Active profile name
  NO_COLOR         Disable colored output

Create Default Config

bash
rledger config init

Creates ~/.config/rledger/config.toml with default settings.

Edit Config

bash
rledger config edit

Opens the config file in the editor configured via default.editor in the config, or the $VISUAL/$EDITOR environment variables.

List Aliases

bash
rledger config aliases

Output:

Configured aliases:

  bal = "report balances"
  inc = "report income"

Usage: rledger <alias> [additional args]

Config File Format

See Configuration for the full config file reference.

See Also