rustledger rustfava PTA Standards
rustledger

rledger doctor ​

Debugging and diagnostic tools for troubleshooting ledger issues.

Usage ​

bash
rledger doctor <SUBCOMMAND> [OPTIONS] [FILE]

Subcommands ​

CommandDescription
lexDump lexer tokens
parseParse and show directives
contextShow context at a line number
linkedFind transactions by link or tag
missing-openGenerate missing Open directives
list-optionsList available beancount options
print-optionsPrint options from a file
statsDisplay ledger statistics
display-contextShow decimal precision context
roundtripParse and re-format (test)
directoriesValidate directory structure
regionPrint transactions in a line range
generate-syntheticGenerate synthetic beancount files for testing

Examples ​

Context at Line ​

Find what's happening around a specific line:

bash
rledger doctor context ledger.beancount 42

Output:

Transaction at line 42:
  Date: 2024-01-15
  Payee: "Coffee Shop"
  Narration: "Morning coffee"

Postings:
  Expenses:Food:Coffee     5.00 USD
  Assets:Cash             -5.00 USD

Account balances after this transaction:
  Expenses:Food:Coffee   125.00 USD
  Assets:Cash            350.00 USD

Find Linked Transactions ​

bash
# Find by link
rledger doctor linked ledger.beancount ^trip-2024

# Find by tag
rledger doctor linked ledger.beancount "#vacation"

Generate Missing Opens ​

bash
# Preview
rledger doctor missing-open ledger.beancount

# Append to ledger
rledger doctor missing-open ledger.beancount >> ledger.beancount

Lexer Debug ​

bash
rledger doctor lex ledger.beancount | head -50

Parse Debug ​

bash
rledger doctor parse ledger.beancount

Statistics ​

bash
rledger doctor stats ledger.beancount

Roundtrip Test ​

Verify parse/format roundtrip:

bash
rledger doctor roundtrip ledger.beancount
bash
rledger doctor print-options ledger.beancount

List All Options ​

bash
rledger doctor list-options

Use Cases ​

Debugging Parse Errors ​

bash
# 1. Check the line with error
rledger doctor context ledger.beancount 42

# 2. See the tokens
rledger doctor lex ledger.beancount | sed -n '40,45p'

Finding Orphan Accounts ​

bash
# Generate opens for accounts used but never opened
rledger doctor missing-open ledger.beancount

Validating Directory Structure ​

bash
# Check that account directories match account hierarchy
rledger doctor directories ledger.beancount documents/

Generate Synthetic Test Data ​

bash
# Generate synthetic ledgers into default directory
rledger doctor generate-synthetic

# Specify output directory and options
rledger doctor generate-synthetic --output tests/synthetic --count 10

See Also ​