Scroll to navigation

BEAN-REPORT(1) User Commands BEAN-REPORT(1)

NAME

bean-report - produces various accounting reports from a Beancount ledger

DESCRIPTION

usage: bean-report [-h] [--version] [--help-reports [HELP_REPORTS]]
[--help-formats [HELP_FORMATS]] [-f {text,csv,html,htmldiv,xls,ofx,beancount}] [-o OUTPUT] [-t] [-q] FILENAME.beancount {balances,bal,trial,balsheet,income,journal,register,account,conversions,documents,holdings,cash,networth,equity,export_holdings,export_portfolio,pfexport,exportpf,commodities,lifetimes,prices,all_prices,pricedb,pricesdb,prices_db,tickers,symbols,check,validate,errors,print,accounts,current_events,latest_events,events,activity,updated,stats-types,stats-directives,stats-entries,stats-postings,ledger,hledger} ...

Produce various custom implemented reports.

positional arguments:

FILENAME.beancount
The Beancount input filename to load.

optional arguments:

-h, --help
show this help message and exit
--version, -V
show program's version number and exit
--help-reports [HELP_REPORTS], --list-reports [HELP_REPORTS]
Print the full list of supported reports and exit.
--help-formats [HELP_FORMATS], --list-formats [HELP_FORMATS]
Print the full list of supported formats and exit.
-f {text,csv,html,htmldiv,xls,ofx,beancount}, --format {text,csv,html,htmldiv,xls,ofx,beancount}
Output format.
-o OUTPUT, --output OUTPUT
Output filename. If not specified, the output goes to stdout. The filename is inspected to select a sensible default format, if one is not requested.
-t, --timings, --verbose
Print timings.
-q, --no-errors
Do not report errors.

report:

{balances,bal,trial,balsheet,income,journal,register,account,conversions,documents,holdings,cash,networth,equity,export_holdings,export_portfolio,pfexport,exportpf,commodities,lifetimes,prices,all_prices,pricedb,pricesdb,prices_db,tickers,symbols,check,validate,errors,print,accounts,current_events,latest_events,events,activity,updated,stats-types,stats-directives,stats-entries,stats-postings,ledger,hledger}
Name/specification of the desired report.
April 2019 bean-report 2.2.0