Repository files navigation

Ledger is a powerful, double-entry accounting system that is accessed from theUNIX command-line. This may put off some users, since there is no flashy UI,but for those who want unparalleled reporting access to their data there arefew alternatives.

Ledger uses text files for input. It reads the files and generates reports;there is no other database or stored state. To use Ledger, you create afile of your account names and transactions, run from the command line withsome options to specify input and requested reports, and get output.The output is generally plain text, though you could generate a graph orhtml instead. Ledger is simple in concept, surprisingly rich in ability,and easy to use.

I know, you just want to build and play. If you have all thedependenciesinstalled, then simply do this:

$ git clone git@github.com:ledger/ledger.git$ cd ledger && ./acprep update  # Update to the latest, configure, make

Now try your first ledger command:

$ ./ledger -f test/input/sample.dat reg

For help on keeping your journal have a look at thedocumentation, thewiki,and theResources section at the end of this file.An Emacs mode for Ledger files can be found in theledger/ledger-mode repository and a vim plugin is located in theledger/vim-ledger repository.

If you have Docker installed on your computer or server, you can use aDocker version of this software, without installing any further dependencies:

$ docker run --rm -v "$PWD"/test/input:/data dcycle/ledger:1 -f /data/sample.dat reg

If you wish to proceed in this venture, you'll need a few dependencies.Note that some features, e.g.--import require building Ledger with Python support.The easiest way to get them for your platform is to run this handy Python script:

$ ./acprep dependencies

If that doesn't completely work, here are the dependencies for building thecurrentmaster branch:

You can useHomebrew orMacPorts to install build dependencies for Ledgereasily on macOS.

If you use Homebrew, to install the dependencies you would run:

$ brew install cmake boost boost-python3 gmp mpfr

If you build stuff using MacPorts on macOS, as I do, here is what you wouldrun:

$ sudo port install -f cmake python37 \     libiconv zlib gmp \     mpfr ncurses ncursesw \     gettext libedit boost-jam \     boost +st+python37+icu texlive doxygen graphviz \     texinfo lcov sloccount

The dependencies for building Ledger are available fromconda-forge on certainplatforms (for example,linux-64), which can be used withConda ormamba.

With Conda you could run:

$ conda install -c conda-forge python=3 cmake boost gmp mpfr \     gettext libedit texinfo doxygen graphviz

If you're going to build on Ubuntu,sudo apt-get install ... thefollowing packages (current as of Ubuntu 18.04):

$ sudo apt-get install build-essential cmake doxygen \     libboost-system-dev libboost-dev python3-dev gettext git \     libboost-date-time-dev libboost-filesystem-dev \     libboost-iostreams-dev libboost-python-dev libboost-regex-dev \     libboost-test-dev libedit-dev libgmp3-dev libmpfr-dev texinfo tzdata

Debian 10 (bullseye), Debian 11 ("bullseye"), Debian testing and Debianunstable (sid) contain all components needed to build ledger. You caninstall all required build dependencies using the following command:

$ sudo apt-get install build-essential cmake autopoint texinfo python3-dev \     zlib1g-dev libbz2-dev libgmp3-dev gettext libmpfr-dev \     libboost-date-time-dev libboost-filesystem-dev \     libboost-graph-dev libboost-iostreams-dev \     libboost-python-dev libboost-regex-dev libboost-test-dev

You can install all required build dependencies under Fedora using thefollowing command (tested with Fedora 32):

$ sudo dnf install boost-date-time boost-devel boost-filesystem \    boost-iostreams boost-python3-devel boost-regex boost-system \    boost-test cmake doxygen gettext git gmp-devel libedit-devel \    mpfr-devel python3-devel texinfo tzdata

The next step is preparing your environment for building. While you can usecmake . and make, I've prepared a script that does a lot more of thefootwork for you:

$ ./acprep update# or, if you want to use the Boost libraries with suffix -mt, install in# $HOME/local and build with 2 processes in parallel$ ./acprep update --boost-suffix=-mt --prefix=$HOME/local -j2

Please read the contents ofCMakeFiles/CMakeOutput.log andCMakeFiles/CMakeError.log if the configure step fails. Also,see thehelp subcommand toacprep, which explains some of its manyoptions. It's pretty much the only command I run for configuring, buildingand testing Ledger.

You can runmake check to confirm the result, andmake install to install.

Now that you're up and running, here are a few resources to keep in mind:

• Homepage
• Documentation
• IRC channel: #ledger channel on Libera Chat
• Mailing List / Forum
• GitHub project page
• Code analysis

If you have ideas you'd like to share, the best way is either to e-mail me apatch (I prefer attachments over pasted text), or toget an account on GitHub.Once you do, fork theLedger project,hack as much as you like, thenopen a pull request on GitHub.