tackler
| Crates.io | tackler |
| lib.rs | tackler |
| version | |
| source | src |
| created_at | 2023-01-19 15:38:05.180652 |
| updated_at | 2024-12-26 05:26:47.421083 |
| description | Fast, reliable bookkeeping tool with native GIT SCM support for plain text accounting |
| homepage | https://tackler.e257.fi/ |
| repository | https://github.com/e257-fi/tackler-ng |
| max_upload_size | |
| id | 762654 |
| Cargo.toml error: | TOML parse error at line 24, column 1 | 24 | autolib = false | ^^^^^^^ unknown field `autolib`, expected one of `name`, `version`, `edition`, `authors`, `description`, `readme`, `license`, `repository`, `homepage`, `documentation`, `build`, `resolver`, `links`, `default-run`, `default_dash_run`, `rust-version`, `rust_dash_version`, `rust_version`, `license-file`, `license_dash_file`, `license_file`, `licenseFile`, `license_capital_file`, `forced-target`, `forced_dash_target`, `autobins`, `autotests`, `autoexamples`, `autobenches`, `publish`, `metadata`, `keywords`, `categories`, `exclude`, `include` |
| size | 0 |
35V LG84 (35VLG84)
documentation
README
Tackler-NG: Tackler CLI Application
Tackler is fast, reliable bookkeeping tool with native GIT SCM support for plain text accounting, written in Rust.
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
Project Status
Tackler-NG is in feature parity with the old scala based Tackler CLI, and Tackler-NG will be the basis of all future Tackler development.
NOTE: Tackler-NG is tested with 284 of tackler's test vectors at the moment
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 and Shares
- Transaction Filters for powerfull selectors of accounting data
- Accounting based on Geo Location and Transaction GIS Filters
See tackler --help and Tackler Configuration how to use tackler-ng.
Build and install tackler
# Get the source code
git clone --recurse-submodules https://github.com/e257-fi/tackler-ng
cd tackler-ng
# The main branch should build and pass all tests.
# To build a release, check relased versions:
git tag -l
# Get the release, e.g. v24.12.2
git checkout v24.12.2
# Build tackler
cargo build --release --locked --bin tackler
# the binary is located at 'target/release/tackler'
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 420
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
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.00 a:ay2016
-6.00 -6.00 a:ay2016:am02
-14.00 -14.00 a:ay2016:am03
-19.00 -19.00 a:ay2016:am04
-26.00 -26.00 a:ay2016:am05
-1.00 -1.00 a:ay2016:am07
-7.00 -7.00 a:ay2016:am08
-13.00 -13.00 a:ay2016:am09
-19.00 -19.00 a:ay2016:am10
-25.00 -25.00 a:ay2016:am11
-31.00 -31.00 a:ay2016:am12
=====================
-161.00
##################################################################################
Report with 100_000 Transactions
There is git ref 'txns-1E5' inside the example audit -repository.
target/release/tackler \
--config examples/audit.toml \
--input.git.ref txns-1E5
Output
Git Storage
commit : cb56fdcdd2b56d41fc08cc5af4a3b410896f03b5
reference : txns-1E5
directory : txns
suffix : .txn
message : txns-1E5: 2016/12
Txn Set Checksum
SHA-256 : 27060dc1ebde35bebd8f7af2fd9815bc9949558d3e3c85919813cd80748c99a7
Set size : 100000
**********************************************************************************
Account Selector Checksum
SHA-256 : 19d31a48bf9a8604a1128ccfd281511f961c5469748a97897a21fc0fa2a5f519
Balance Report
--------------
0.00 -1574609.01 a:ay2016
-135600.00 -135600.00 a:ay2016:am01
-118950.00 -118950.00 a:ay2016:am02
-135631.00 -135631.00 a:ay2016:am03
-127137.00 -127137.00 a:ay2016:am04
-135616.00 -135616.00 a:ay2016:am05
-127154.00 -127154.00 a:ay2016:am06
-135600.00 -135600.00 a:ay2016:am07
-135603.00 -135603.00 a:ay2016:am08
-127140.00 -127140.00 a:ay2016:am09
-135619.00 -135619.00 a:ay2016:am10
-127126.00 -127126.00 a:ay2016:am11
-133433.00 -133433.00 a:ay2016:am12
=========================
-1574609.01
##################################################################################
Transaction Filters
Filter definition
target/release/tackler \
--config examples/audit.toml \
--input.git.ref txns-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:eyJ0eG5GaWx0ZXIiOnsiVHhuRmlsdGVyUG9zdGluZ0FjY291bnQiOnsicmVnZXgiOiJeYTpheTIwMTY6YW0xMiJ9fX0=
Output
Git Storage
commit : cb56fdcdd2b56d41fc08cc5af4a3b410896f03b5
reference : txns-1E5
directory : txns
suffix : .txn
message : txns-1E5: 2016/12
Txn Set Checksum
SHA-256 : 51faa6d2133d22d3ff8b60aff57722d1869fc4677911b13161dce558e7498073
Set size : 8406
Filter
Posting Account: "^a:ay2016:am12"
**********************************************************************************
Account Selector Checksum
SHA-256 : 19d31a48bf9a8604a1128ccfd281511f961c5469748a97897a21fc0fa2a5f519
Balance Report
--------------
0.00 -133433.00 a:ay2016
-133433.00 -133433.00 a:ay2016:am12
========================
-133433.00
##################################################################################
Further info
Tackler components on Crates.io
- Tackler CLI application: tackler
- Tackler Client API: tackler-api
- Tackler Server API: tackler-core
- Tackler Rusty Services: tackler-rs