Skip to main content

Beancount

TablePro opens .beancount ledgers as read-only, file-based connections. If the Beancount plugin is not installed yet, TablePro prompts you to download it before opening the ledger. The driver projects transactions, postings, accounts, prices, computed balances, balance assertions, and source files into SQL tables for browsing and exports. The plugin uses either rledger (the rustledger project) or Python Beancount to parse ledgers. Install one of those backends separately. When both are available, TablePro uses rledger; Python Beancount is used as a fallback for browsing projected SQL tables. The plugin also supports BQL queries through rledger. BQL requires the rledger executable even when the ledger was opened through Python Beancount.

Backend requirements

TablePro does not bundle a Beancount parser. It discovers backends in this order:
  1. rledger from TABLEPRO_RUSTLEDGER_BINARY, PATH, or standard Homebrew locations.
  2. Python Beancount from TABLEPRO_BEANCOUNT_PYTHON, PATH, or standard Python locations.
Other Beancount-compatible parsers are not discovered unless they expose one of these supported interfaces. To verify rledger:
To verify Python Beancount:
If TablePro cannot find a supported backend, set the executable path before launching the app:
To force a backend:

Connecting to a Beancount ledger

1

Create a new connection

Open TablePro and click New Connection or press Cmd+N.
2

Select Beancount

Choose Beancount from the database type list.
3

Choose your ledger file

Click Browse and select a .beancount file.
4

Connect

Click Save & Connect to open the ledger.
Beancount ledger open in TablePro with projected tables in the sidebar

A Beancount ledger projected into SQL tables

Connection URL

See Connection URL Reference for all parameters.

Tables

Amounts are read straight from rledger, so thousands separators, arithmetic, cost ({}), and price (@/@@) annotations are resolved to their booked values.

Includes

The parser follows Beancount include directives. Literal includes and glob patterns such as include "imports/*.beancount" and include "imports/**/*.beancount" are supported.

BQL

Prefix a query with BQL: to run it through your configured rledger executable:
Table browsing, row counts, and pagination work for BQL results. BQL queries do not support SQL parameters.

Limitations

  • Beancount connections are read-only.
  • Schema editing, imports, SSH, SSL, and database switching are not available for ledgers.
  • The SQL projection covers common ledger directives; unsupported directives remain available in the original source files.