• Tackler is fast

• Support for Commodities and Currencies

• Text and JSON output formats for reports

  • Server API for embedding Tackler core

  • Client API for JVM and JS environments

• Integrated support with GIT version control system

  • Can use plain filesystem or GIT repository as data storage

  • Natively supports splitting journal data to multiple files (shards)

• Clean and simple journal format

• Strict account name validation with Chart of Accounts

• Multiple report and export types:

  • Balance, Balance Groups and Register Reports

  • Equity and Identity Exports

• Support for Transaction Filters

• Supports UTF-8 characters in transaction data (descriptions, comments, account names)

• Supports ISO 8601 timestamps with timezones and nanosecond resolution

• Has good performance with large transaction set

  • Tackler is tested up to one million (1E6) transactions

  • Tackler can parse and process 56000 txn/s on Quad Core system

• Near 100% test coverage, all features are extensively tested

• Extensive documentation: Index of Docs

Tackler’s idea is provide concise, minimal and reliable engine to process text-based human readable accounting records.

Concise means that Tackler’s journal format is semantically concise and easy for humans to reason about.

Minimal means that Tackler provides minimum set of features which are needed for its operation.

Reliable means that Tackler’s behaviour is well known, tested and it is documented.

All that said, Tackler can be used easily from command line with normal personal accounting data sets.

Tackler Goals

User documentation is located under docs:

• Index of Documentation

• Installation Manual

• Tackler journal format

• Usage Guide

• Configuration Manual

• Example of Tackler Conf. (tackler.conf)

• Example of Tackler Chart of Accounts (accounts.conf)

• Example of Trimix Filling Station Accounting system (for scuba diving)

• Server API documentation

• Client API documentation

• Developer’s documentation

At the moment, current set of active todo items is kept todo files.

There are Tackler Enhancement Proposals for planning and tracking implementation of major new features. These are listed on TEP index.

Roadmap

For release information and version history details, see CHANGELOG.

Tackler-core is supposed to be usable as separate component. Tackler-api is released for JVM and JS environments, and it is intended to be used on the client side. See Server API and Client API for additional information.

Dependency settings for SBT are:

These are released on Maven Central Repository.

Tackler is under development, so if you enjoy calm seas then it might be better to look something else.

However, complex backward non-compatible changes to Journal file format should be rare. At the moment Tackler is used in production for operational data set.

Configuration files, command line interface and Client API (data models) are more likely to subject of change.

Contributions to the project are most welcome. See CONTRIBUTING how you could help.

Your pull requests can be merged only if you can certify the Developer Certificate of Origin (DCO), Version 1.1. To certify DCO (e.g. sign-off your commit), you must add a Signed-off-by line to every git commit message (e.g. by using git commit -s):

If you set your user.name and user.email in git config, then git will include that line for you with git commit -s. These settings can be done per repository basis, so they don’t have be global settings in your system.

Please make sure that you sign-off all your PR’s commits.

See THANKS for full list of credits.