Skip to main content

Crate rustledger

Crate rustledger 

Source
Expand description

Beancount CLI tools.

This crate provides command-line tools for working with Beancount files:

  • rledger check / bean-check: Validate a beancount file
  • rledger format / bean-format: Format a beancount file
  • rledger query / bean-query: Query with BQL
  • rledger report / bean-report: Generate reports
  • rledger doctor / bean-doctor: Debugging tools

§Example Usage

rledger check ledger.beancount
rledger format ledger.beancount
rledger query ledger.beancount "SELECT account, SUM(position)"

rustledger is a workspace with several crates:

CrateDescription
rustledger-coreCore types (Amount, Position, Inventory, Directives)
rustledger-parserLexer and parser with error recovery
rustledger-loaderFile loading, includes, options
rustledger-bookingInterpolation and booking engine
rustledger-validateValidation with error reporting
rustledger-queryBQL query engine
rustledger-pluginNative and WASM plugin system
rustledger-wasmWebAssembly library target
rustledger-importerImport framework for bank statements
rustledger-lspLanguage Server Protocol implementation
rustledger-ffi-wasiFFI via WASI for embedding

Modules§

cmd
Command implementations for CLI tools.
config
Configuration file support for rledger CLI.
pager
Pager support for long output.
report
Error reporting with beautiful diagnostics.