bean-format(1)

pretty print and align a Beancount ledger

Section 1 beancount bookworm source

Description

BEAN-FORMAT

NAME

bean-format - pretty print and align a Beancount ledger

DESCRIPTION

usage: bean-format [-h] [--version] [-o OUTPUT] [-w PREFIX_WIDTH]

[-W NUM_WIDTH] [-c CURRENCY_COLUMN] [filename]

Align a beancount/ledger input file’s numbers. This reformats at beancount or ledger input file so that the amounts in the postings are all aligned to the same column. The currency should match. Note: this does not parse the Beancount ledger. It simply uses regular expressions and text manipulations to do its work.

positional arguments:

filename

Beancount filename

options:

-h, --help

show this help message and exit

--version, -V

show program’s version number and exit

-o OUTPUT, --output OUTPUT

Output file (stdout if not specified)

-w PREFIX_WIDTH, --prefix-width PREFIX_WIDTH

Use this prefix width instead of determining an optimal value automatically

-W NUM_WIDTH, --num-width NUM_WIDTH

Use this width to render numbers instead of determining an optimal value

-c CURRENCY_COLUMN, --currency-column CURRENCY_COLUMN

Align currencies in this column.