Quickstart for Tackler-NG

This is minimal quickstart setup for Tackler-NG versions 24.11.1 or higher.

See Journal Format, tackler.toml, accounts.toml, commodities.toml and tags.toml for tackler-ng configuration.

Rust toolchain

At the moment there aren’t precompiled binaries available, so tackler-ng has to be build first. If you don’t have Rust toolchain installed in your system, get it here:

curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

How to get the source and to build Tackler-NG

# Get the source code
git clone --recurse-submodules https://github.com/e257-fi/tackler-ng

cd tackler-ng

# Select the latest release
git checkout v24.11.1

# Build the tackler
cargo build --release --locked --bin tackler

# Check the version info
target/release/tackler --version

tackler 24.11.1 (v24.11.1 - 8e9ce277d3fd6f8)

Simple example

This uses filesystem based storage backend, no account name validations, no auditing features.

Command

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

Output

**********************************************************************************

Balance Report
--------------
                 0.00   12.00  Expenses:Food
                12.00   12.00  Expenses:Food:Groceries
                 0.00    3.32  Expenses:Sweets
                 2.12    2.12  Expenses:Sweets:Ice·cream
                 1.20    1.20  Expenses:Sweets:Salmiakki
=====================
                15.32
##################################################################################
**********************************************************************************
...
...
...

Let’s play for real - Git storage and Audit mode

This example uses a bare git repository as transaction storage, and also strict and audit mode is activated by configuration. This means that all accounts, commodity names and tags are validated. The triplet of git commit id, Txn Set Checksum and Account Selector Checksum provides an auditable (cryptographic) proof of transactions used by reports.

Command

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

Output

Git Storage
         commit : 4aa4e9797501c1aefc92f32dff30ab462dae5545
      reference : txns-1E1
      directory : txns
         suffix : .txn
        message : txns-1E1: 2016/12

Txn Set Checksum
        SHA-256 : 9b29071e1bf228cfbd31ca2b8e7263212e4b86e51cfee1e8002c9b795ab03f76
       Set size : 10

**********************************************************************************
Account Selector Checksum
        SHA-256 : 19d31a48bf9a8604a1128ccfd281511f961c5469748a97897a21fc0fa2a5f519

Balance Report
--------------
                 0.00   -161.0000  a:ay2016
              -6.0000     -6.0000  a:ay2016:am02
             -14.0000    -14.0000  a:ay2016:am03
             -19.0000    -19.0000  a:ay2016:am04
             -26.0000    -26.0000  a:ay2016:am05
              -1.0000     -1.0000  a:ay2016:am07
              -7.0000     -7.0000  a:ay2016:am08
             -13.0000    -13.0000  a:ay2016:am09
             -19.0000    -19.0000  a:ay2016:am10
             -25.0000    -25.0000  a:ay2016:am11
             -31.0000    -31.0000  a:ay2016:am12
=====================
            -161.0000
##################################################################################