rledger check

Validate a beancount ledger file for syntax errors and semantic issues.

Usage

bash

rledger check [OPTIONS] [FILE]

Arguments

Argument	Description
`FILE`	The beancount file to check (uses `$RLEDGER_FILE` or config if not specified)

Options

Option	Description
`-P, --profile <PROFILE>`	Use a profile from config
`-v, --verbose`	Show verbose output including timing
`-q, --quiet`	Suppress all output (just use exit code)
`-C, --no-cache`	Disable the binary cache for parsed directives
`-a, --auto`	Implicitly enable auto-plugins (`auto_accounts`, etc.)
`--plugin <WASM_FILE>`	Load a WASM plugin (can be repeated)
`--native-plugin <PLUGIN>`	Enable a native plugin (can be repeated)
`-f, --format <FORMAT>`	Output format: `text`, `json`

Examples

Basic Validation

bash

rledger check ledger.beancount

Output on success:

✓ No errors found

Output with errors:

error[E3001]: Transaction does not balance
  --> ledger.beancount:42:1
   |
42 | 2024-01-15 * "Coffee shop"
   | ^^^^^^^^^^^^^^^^^^^^^^^^^
   = help: Expenses:Food has 5.00 USD, Assets:Bank has -4.99 USD
   = note: residual: 0.01 USD

✗ 1 error

With Plugins

bash

# Enable specific plugins
rledger check --native-plugin auto_accounts --native-plugin implicit_prices ledger.beancount

# Plugins declared in the file are auto-detected
# plugin "beancount.plugins.auto_accounts"  <- uses native implementation

JSON Output

bash

rledger check -f json ledger.beancount

json

{
  "valid": false,
  "errors": [
    {
      "code": "E3001",
      "message": "Transaction does not balance",
      "file": "ledger.beancount",
      "line": 42,
      "help": "Expenses:Food has 5.00 USD, Assets:Bank has -4.99 USD"
    }
  ]
}

Using Environment Variable

bash

export RLEDGER_FILE="$HOME/finances/main.beancount"
rledger check  # uses $RLEDGER_FILE

Error Codes

Common validation errors:

Code	Description
E1001	Syntax error
E2001	Account not opened
E2002	Account already opened
E3001	Transaction does not balance
E3002	Invalid balance assertion

See Error Reference for all error codes.

rledger check ​

Usage ​

Arguments ​

Options ​

Examples ​

Basic Validation ​

With Plugins ​

JSON Output ​

Using Environment Variable ​

Error Codes ​

See Also ​

rledger check

Usage

Arguments

Options

Examples

Basic Validation

With Plugins

JSON Output

Using Environment Variable

Error Codes

See Also