lumi 0.2.0

A library for processing text-based ledger files.
Documentation

lumi

GHA Build Status MIT licensed

lumi is a collection of double-entry accounting tools:

  • lumi, a library for processing text-based ledger files, including a LL(1) parser (compatible with beancount syntax) and a transaction checker.
  • lumi-cli, a command line tool for parsing the leger file, presenting account balances, and serving a web UI, based on tokio and warp.
  • lumi-web, a front-end UI for presenting account balances and transaction history, based on Yew.

Build && Installation

The source code of lumi can be obtained from https://github.com/Lencerf/lumi. To build lumi from source,

# Install dependencies
cargo install wasm-bindgen-cli

# build
git clone https://github.com/Lencerf/lumi && cd lumi
cargo build --bin lumi --release

lumi binary is available at target/release/lumi.

Usage

lumi -i /path/to/leger $COMMAND

COMMAND can be

  • balances: show balances of all accounts,
  • files: show the list of source files,
  • serve: start an HTTP server at 127.0.0.1:8001 and present a Web UI presenting account balances and the transaction history.

Check lumi --help and lumi $COMMAND --help for more details.