limabean

This is a new implementation of Beancount using Rust and Clojure and the Lima parser.

Rust is purely used for backend processing, and has no visbility to end users beyond the build process. The idea is to use Clojure for interactive Beancounting instead of Beancount Query Language and Python. The Clojure REPL will provide all interactivity required.

There is no intention for limabean to support either Beancount Query Language or Python.

Some pre-canned queries are likely to be provided as command line options, but the main interactive experience is intended to be within the Clojure REPL.

Installation

Tarballs and zipfiles are provided for each GitHub release for Linux, macOS, and Windows.

The Clojure CLI is required to be installed separately, and clojure must be on the user's path.

macOS

On macOS it is necessary to remove the quarantine attributes after unpacking the tarball, e.g.

xattr -rd com.apple.quarantine ./limabean/bin

Windows

• install OpenJDK 25 MSI
• install Clojure 1.12 MSI
• download limabean zipfile from GitHub releases and extract somewhere
• add that directory to path

Beware unable to detect a system Terminal on Windows #5

Usage

kiri> limabean --beanfile ./examples/beancount/simple.beancount

[Rebel readline] Type :repl/help for online help info
[limabean] 18 directives loaded from ./examples/beancount/simple.beancount
user=> (show (inventory))
Assets:Bank:Current                       -100.78 NZD
Assets:Bank:UK                              -5.00 GBP
Expenses:Donations                          10.00 NZD
Expenses:Donations:Other                    20.00 NZD
Expenses:Entertainment:Drinks-and-snacks    48.00 NZD
Expenses:Groceries                           5.00 GBP
                                            27.50 NZD
Income:Unknown                              -4.72 NZD
:ok

To be completed

Import

For a new approach to import see limabean-harvest.

Balance assertions

A point of difference from classic Beancount is that balance assertions may be configured to assert the total for an account an all its subaccounts, using the internal plugin limabean.balance_rollup. For example, if a bank account holds multiple logical amounts, they may be tracked as subaccounts, without violating balance assertions.

Padding is only ever performed on the actual account asserted in the balance directive, never on its subaccounts.

Unless the plugin is enabled, the default behaviour is not to do this.

Plugins

limabean does not (yet) support externally provided plugins. The intention is that all desired behaviour may be implemented by the end user in Clojure. It remains to be seen whether auto-loading of Clojure plugins will be a useful feature.

That said, there are a handful of internal plugins, as follows.

Implicit Prices

The existing plugin beancount.plugins.implicit_prices is built in.

Auto Accounts

The existing plugin beancount.plugins.auto_accounts is not yet supported, but will be implemented as a built-in plugin.

Balance Rollup

As described above, the plugin limabean.balance_rollup modifies the behaviour of the balance directive.

Running the development version

limabean supports running from a local copy of the repo. Simply set the environment variable LIMABEAN_CLJ_LOCAL_ROOT to the path of the clj directory. Passing the -v or --verbose flag reveals what is happening.

kiri> echo $LIMABEAN_CLJ_LOCAL_ROOT

kiri> limabean -v --beanfile ./examples/beancount/simple.beancount
"clojure" "-Sdeps" "{:deps {io.github.tesujimath/limabean {:mvn/version \"0.1.0\"}}}\n" "-M" "-m" "limabean.main" "-v" "--beanfile" "./examples/beancount/simple.beancount"


kiri> echo $LIMABEAN_CLJ_LOCAL_ROOT
/Users/sjg/vc/tesujimath/limabean/clj

kiri> ls $LIMABEAN_CLJ_LOCAL_ROOT
CHANGELOG.md  README.md  build.clj  deps.edn  doc/  resources/  src/  target/  test/

kiri> limabean -v --beanfile ./examples/beancount/simple.beancount
"clojure" "-Sdeps" "{:deps {io.github.tesujimath/limabean {:local/root \"/Users/sjg/vc/tesujimath/limabean/clj\"}}}\n" "-M" "-m" "limabean.main" "-v" "--beanfile" "./examples/beancount/simple.beancount"

Also, since the limabean does nothing beyond launching the Clojure code, it is also possible to dispense with it altogether and run purely from the project directory, for example:

kiri> cd $LIMABEAN_CLJ_LOCAL_ROOT
kiri> clojure -M -m limabean.main --beanfile ../examples/beancount/simple.beancount
[Rebel readline] Type :repl/help for online help info
[limabean] 18 directives loaded from ../examples/beancount/simple.beancount
user=>

Contributions

While issues are welcome and I am particularly interested in making this generally useful to others, given the current pace of development I am unlikely to be able to accept PRs for now.

License

Licensed under either of

• Apache License, Version 2.0 LICENSE-APACHE
• MIT license LICENSE-MIT

at your option.