BEAN-REPORT(1)

💖 BEAN-REPORT(1) 💖

okay bestie, welcome to bean-report — it's a User Commands situation, and it literally produces all the accounting reports you could ever want from a Beancount ledger. no cap. 🫘✨

---

✨ 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. that's the whole vibe. 🦋

---

🧚 positional arguments

• FILENAME.beancount — the Beancount input filename to load. yes, that exact one. your ledger, your moment, main character energy. 👑

---

💅 options

• -h, --help — show this help message and exit. classic. iconic. we love a helper. 🙈
• --version, -V — show program's version number and exit. so you know exactly which era of bean you're in. ⭐
• --help-reports [HELP_REPORTS], --list-reports [HELP_REPORTS] — print the full list of supported reports and exit. it's giving menu. 🍓
• --help-formats [HELP_FORMATS], --list-formats [HELP_FORMATS] — print the full list of supported formats and exit. also a menu, but for formats. 🌈
• -f {text,csv,html,htmldiv,xls,ofx,beancount}, --format {text,csv,html,htmldiv,xls,ofx,beancount} — output format. pick your aesthetic. 🎀
• -o OUTPUT, --output OUTPUT — output filename. if you don't specify one, the output goes to stdout. and here's the cute part: the filename gets inspected to select a sensible default format, if one is not requested. it just knows. 🔥
• -t, --timings, --verbose — print timings. for the girlies who need to know how long things took. ⏱️
• -q, --no-errors — do not report errors. living in denial but make it a flag. 💀

---

👑 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. yes, that is the entire list, and yes, you must pick one. choose wisely bestie. 💖

ngl, the synopsis also ends in ... — because there's more spec to come after the report name. the vibes continue. 😭

---

and that's the whole page, fr fr. bean-report 2.3.6, April 2024 — mwah, slay, periodt. 💅🫶