BEAN-QUERY(1)

πŸ“¦
version 2.3.6 Β· 3 versions
, in ubuntu noble

πŸ’– NAME πŸ’–

bean-query β€” bestie, it's an interactive shell for the Beancount Query Language ✨ (yes, this is section 1, the User Commands manual, we're fancy like that πŸ’…)


✨ DESCRIPTION ✨

okay so picture this: you've got a Beancount file, and you wanna talk to it. That's her. She's an interactive command-line shell interpreter for the Beancount Query Language, and she eats. πŸ“

Here's how you call her:

bean-query [-h] [--version] [-f {text,csv}] [-m] [-o OUTPUT] [-q]

       FILENAME.beancount [query ...]

No cap, that's the whole vibe. Now let's break down every single piece because we do not skip details in this house 🫢

🌸 positional arguments 🌸

  • FILENAME.beancount β€” the Beancount input filename to load. this is the snack she's gonna read, you gotta hand it over first, no skipping πŸ™ˆ
  • query β€” a query to run directly. like, right there, immediately, no small talk. just query and go πŸ’¨

πŸŽ€ options πŸŽ€

  • -h, --help β€” shows this help message and then dips out (exit). iconic behaviour honestly πŸ‘‘
  • --version, -V β€” shows the program's version number and exits. she'll tell you exactly who she is, then leave. main character energy fr fr πŸ’…
  • -f {text,csv}, --format {text,csv} β€” output format. pick your aesthetic: text or csv, that's the menu 🌈
  • -m, --numberify β€” numberify the output, removing the currencies. all the digits, none of the currency labels. just the numbers, raw, unbothered ✨
  • -o OUTPUT, --output OUTPUT β€” output filename. if you don't specify one, the output goes to stdout (aka straight to your terminal, as nature intended πŸ’–). and here's the cute part: the filename gets inspected to select a sensible default format, if one is not requested. so she's reading the vibe of your filename and matching it, periodt πŸ”₯
  • -q, --no-errors β€” do not report errors. the errors stay silent. she simply will not be discussing it 🀐
lowkey important: these option descriptions are exactly what the original says, so don't go reading extra behaviour into -q β€” it just means errors aren't reported. that's it, that's the tea πŸ«–

and that's the whole page, bestie!! go query something, you're gonna slay πŸ’œ

🌸✨ this has been bean-query 2.3.6, from April 2024 β€” mwah, bye πŸŽ€πŸ¦‹

πŸ“¦ where this page comes from