Tackler: Tackler CLI Application

Tackler is fast (1), reliable bookkeeping tool with native GIT SCM support for plain text accounting, written in Rust.

cargo install --locked tackler
tackler new demo
tackler --config demo/conf/tackler.toml

This will produce balance and register reports for the demo journal.

Balance Report
--------------
                 0.00    17.50  Expenses
                 0.00    12.00  Expenses:Food
                12.00    12.00  Expenses:Food:Fast-Food
                 0.00     5.50  Expenses:Sweets
                 2.50     2.50  Expenses:Sweets:Candy
                 3.00     3.00  Expenses:Sweets:Ice·Cream
=====================
                17.50

Register Report
---------------
...

1. Tackler has excellent performance, it can process 700_000 transactions per second on modern laptop. See Tackler Performance for details.

Project Status

Tackler is reimplementation of nearly 10 years old Scala based system, and it's in feature parity with and beyond of the old Scala code base. Tackler is using the same test and reference vectors as the tackler-mk1. This is basis of all the future Tackler development.

NOTE: Tackler is tested with 436 tracked test vectors

All Tackler CLI functionality is supported, including Tackler Journal Format, transaction storages (FS backend, Gitoxide based Git backend), all reports (Balance, Balance Group, Register) and all exports (Equity, Identity).

Other notable features are:

• Commodities, Currencies and Shares
• New support for Market Value of Commodities and Shares, including different valuation (Mark-to-Market) methods:
  • Current Market Value
  • Historic Market Value
  • Variable Market Value
• Transaction Filters for powerful selectors of accounting data
• Real transaction timestamps up to nanosecond resolution and with timezone information
  • Plain dates are also supported
  • Also Civil date times without zone information
• Accounting based on Geo Location and Transaction GIS Filters
• Optional JSON Output

See tackler --help and Tackler Documentation how to use tackler.

Installation

You can install tackler binary directly by cargo:

# Latest released version
cargo install --locked tackler

# Latest development version
cargo install --locked --git https://github.com/tackler-ng/tackler tackler

Or build it from the source.

Build the Source Code

The main branch should build and pass all tests all the time.

You have to clone the tackler source code with git submodules, as test vectors are located in a separate repository.

git clone --recurse-submodules https://github.com/tackler-ng/tackler

Then build the tackler binary - if you have just installed, building tackler is just:

cd tackler
just release-build

Or with plain cargo command:

cd tackler
cargo build --release --locked --bin tackler

Tackler binary will be located at target/release/tackler

Examples

Tackler has multiple examples to demonstrate its functionality: reporting example for Solar Energy Value, Accounting example for Trimix Filling Station

Below are listed some of the simplest one. These examples need tackler source code and test vectors, so make sure you have cloned it out with submodules. If you did not, update the test suite submodule:

git submodule init
git submodule update

Simple example

This setup doesn't have any checks enabled and it uses plain filesystem as transaction storage.

Journal

2024-03-20 'Lucky Day!
   Assets:Bank:Acme_Inc  100
   Income:Lottery

2024-06-20 'Sweet'n Sour Candies
   Expenses:Sweets:Candy  2.50
   Assets:Cash

2024-09-22 'Hot dogs
   Expenses:Food:FastFood  12
   Assets:Visa:4012_8888_8888_1881

2024-12-21 'Strawberry ice cream
   Expenses:Sweets:Ice·Cream  3
   Assets:Cash

Command

target/release/tackler --config examples/simple.toml

Output

Balance Report
--------------
                 0.00    17.50  Expenses
                 0.00    12.00  Expenses:Food
                12.00    12.00  Expenses:Food:FastFood
                 0.00     5.50  Expenses:Sweets
                 2.50     2.50  Expenses:Sweets:Candy
                 3.00     3.00  Expenses:Sweets:Ice·Cream
=====================
                17.50

Let's play for real

Following examples use bare git repository as transaction storage, and also strict and audit mode is activated by configuration.

The triplet of git commit id, Txn Set Checksum and Account Selector Checksum provides auditable (cryptographic) proof of transactions used by reports.

Use Git repository as Transaction storage

Reports with Txn Checksum

target/release/tackler \
    --config examples/audit.toml \

Output

Git Storage
      reference : set-1e1
      directory : txns
      extension : txn
         commit : ed6e4b10de2daea8d143569c473d14a9b09c3270
         author : tackler <accounting@example.com>
           date : 2016-11-25 09:36:00 +0000
        subject : set-1e1: 2016-11-25

Txn Set Checksum
        SHA-256 : 4a0eb2f8836447a025030a87136c047b4a737031162f593cb00f390c6ba113a3
       set size : 10

**********************************************************************************
Account Selector Checksum
        SHA-256 : df4714ff3f5bd031a8256df95863a8085f740b436f1b47febb45c9eb9aaa9e9e
       selector : 'a:.*'


Balance Report
--------------
                -1.00   a:ay2016:am01
                -6.00   a:ay2016:am02
               -14.00   a:ay2016:am03
               -19.00   a:ay2016:am04
               -26.00   a:ay2016:am05
                -2.00   a:ay2016:am07
                -7.00   a:ay2016:am08
               -13.00   a:ay2016:am09
               -19.00   a:ay2016:am10
               -25.00   a:ay2016:am11
=====================
              -132.00
##################################################################################

Report with 100_000 Transactions

There is git ref 'set-1e5' inside the example audit -repository.

target/release/tackler \
    --config examples/audit.toml \
    --input.git.ref set-1e5

Output

Git Storage
      reference : set-1e5
      directory : txns
      extension : txn
         commit : 4648a2994b41ed341b544a148b3060fd2d267d79
         author : tackler <accounting@example.com>
           date : 2016-12-31 17:41:24 +0000
        subject : set-1e5: 2016-12-31

Txn Set Checksum
        SHA-256 : 2f4bc22df78502182aa27037d8d0f72462adb018be3e768399e0b803fa75baa7
       set size : 100000

**********************************************************************************
Account Selector Checksum
        SHA-256 : df4714ff3f5bd031a8256df95863a8085f740b436f1b47febb45c9eb9aaa9e9e
       selector : 'a:.*'


Balance Report
--------------
               -135601.00   a:ay2016:am01
               -118950.00   a:ay2016:am02
               -135631.00   a:ay2016:am03
               -127137.00   a:ay2016:am04
               -135616.00   a:ay2016:am05
               -127154.00   a:ay2016:am06
               -135600.00   a:ay2016:am07
               -135603.00   a:ay2016:am08
               -127140.00   a:ay2016:am09
               -135619.00   a:ay2016:am10
               -127126.00   a:ay2016:am11
               -133402.00   a:ay2016:am12
=========================
              -1574579.01
##################################################################################

Transaction Filters

Filter definition

target/release/tackler \
    --config examples/audit.toml \
    --input.git.ref set-1e5 \
    --api-filter-def '{"txnFilter":{"TxnFilterPostingAccount":{"regex":"a:ay2016:am12"}}}'

The transaction filter definition could be given also as Base64 ascii armored string:

--api-filter-def \
base64:eyJ0eG5GaWx0ZXIiOnsiVHhuRmlsdGVyUG9zdGluZ0FjY291bnQiOnsicmVnZXgiOiJhOmF5MjAxNjphbTEyIn19fQ==

Output

Git Storage
      reference : set-1e5
      directory : txns
      extension : txn
         commit : 4648a2994b41ed341b544a148b3060fd2d267d79
         author : tackler <accounting@example.com>
           date : 2016-12-31 17:41:24 +0000
        subject : set-1e5: 2016-12-31

Txn Set Checksum
        SHA-256 : 8ff80f72dc8b36fd6272319d08b99c54d8cf47baff47eda3df68b69e7b7b66bc
       set size : 8405

Filter
  Posting Account: "a:ay2016:am12"

**********************************************************************************
Account Selector Checksum
        SHA-256 : df4714ff3f5bd031a8256df95863a8085f740b436f1b47febb45c9eb9aaa9e9e
       selector : 'a:.*'


Balance Report
--------------
              -133402.00   a:ay2016:am12
========================
              -133402.00
##################################################################################

Further info

• Tackler Journal Format
• Transaction Filters
• Tackler repository
• Tackler website
• Plain Text Accounting

Tackler components on Crates.io

• Tackler CLI application: tackler
• Tackler Client API: tackler-api
• Tackler Server API: tackler-core
• Tackler Rusty Services: tackler-rs