Download

There are several ways to install hledger:

  1. Download the binary or system package for your platform (quick install, often out of date)
  2. Build the latest release with hledger-install or with stack or with cabal (slow install, up to date)
  3. Build the development version with stack or cabal (slow install, cutting edge)

a. Download a binary or system package for your platform

Binaries or system packages are quickest to install, but they can be outdated or incomplete.

Available binaries / system packages:

(please update this page /
report issues to packagers)

Platform Command/Link Installs version
(latest is 1.12)
Mac brew install hledger
only hledger CLI
1.11.1
Windows Developer binaries: 1.12
no hledger-ui,doesn’t work on old windows ?,many files in PATH causing hangs
1.12
 
Arch Linux pacman -S hledger [hledger-ui] [hledger-web] [hledger-api] 1.12
CentOS ?
Debian sudo apt install hledger hledger-ui hledger-web 1.0.1 (Stable), 1.10 (Testing), 1.10 (Unstable)
Fedora, RHEL sudo dnf install hledger
or (more complete & current):
sudo dnf copr enable kefah/HLedger && sudo dnf install hledger
1.2 (27), 1.4 (28), 1.5 (Rawhide)
1.9.1 (kefah)
Gentoo sudo layman -a haskell && sudo emerge hledger hledger-ui hledger-web 1.11.1
Ubuntu sudo apt install hledger hledger-ui hledger-web 0.26 (16.04), 1.2 (18.04), 1.5 (18.10), 1.5 (19.04)
Void Linux xbps-install -S hledger hledger-ui hledger-web hledger-api 1.10
 
FreeBSD ?
NetBSD ?
OpenBSD Ports: https://github.com/jasperla/openbsd-wip/pull/104
Third-party binaries: OpenBSD6.3/amd64
1.10
 
Nix nix-env -iA nixpkgs.haskellPackages.hledger nixpkgs.haskellPackages.hledger-ui nixpkgs.haskellPackages.hledger-web
problems with hledger-ui on Mac ?
1.10 (stable), 1.11.1 (unstable)
Sandstorm hledger-web Sandstorm app
features needed
1.9.2

b. Build the latest release

Good choice! You’ll get the latest features and fixes mentioned in the release notes, and you’ll be in a good position to give feedback and get support. Below are three ways to build the latest release, in order of preference. But first, some tips:

b1. with hledger-install

On systems with bash installed (mac, linux, unix-like windows..), if you don’t already have stack or cabal, or if you are having trouble with them, hledger-install is an easy and reliable way to get the latest hledger. It automates the install process using stack or cabal, avoiding common pitfalls:

curl -s https://raw.githubusercontent.com/simonmichael/hledger/master/hledger-install/hledger-install.sh > hledger-install.sh
less hledger-install.sh # satisfy yourself that the script is safe
bash hledger-install.sh

b2. with stack

stack is the more reliable of Haskell’s two build tools, for new users. You need stack 1.7.1 or newer; the latest release is best. On 64-bit Windows, use the 64-bit version of stack. The following command installs the main hledger packages; you can save some time by omitting hledger-ui, hledger-web and/or hledger-api (optional user interfaces). On Windows, hledger-ui is not available. To estimate the build time, add --dry-run:

stack install --resolver=lts-12 megaparsec-7.0.4 cassava-megaparsec-2.0.0 config-ini-0.2.3.0 hledger-lib-1.12 hledger-1.12 hledger-ui-1.12 hledger-web-1.12 hledger-api-1.12

Other add-ons like hledger-diff, hledger-iadd, or hledger-interest can be installed like so:

stack install --resolver=lts-12 megaparsec-7.0.4 cassava-megaparsec-2.0.0 config-ini-0.2.3.0 hledger-lib-1.12 hledger-diff-0.2.0.14 hledger-iadd-1.3.7 hledger-interest-1.5.3

b3. with cabal

cabal is the other Haskell build tool. If you’re a cabal expert, use it in the usual way, eg:

cabal update
cabal install hledger-1.12 hledger-ui-1.12 hledger-web-1.12 hledger-api-1.12 hledger-diff-0.2.0.14 hledger-iadd-1.3.7 hledger-interest-1.5.3

Set up PATH

You will probably see a message about where the executables were installed. After installation, make sure this install directory is configured in your shell’s $PATH (preferably near the start of it, to preempt older hledger system packages you may have installed). The install directory is:

on non-Windows systems on Windows
If stack was used $HOME/.local/bin %APPDATA%\local\bin (eg C:\Users\Joe\AppData\Roaming\local\bin)
If cabal was used $HOME/.cabal/bin %APPDATA%\cabal\bin

How to configure $PATH is platform- and shell-specific. If you are using bash, this should take care of it:

echo "export PATH=~/.local/bin:~/.cabal/bin:$PATH" >> ~/.bashrc && source ~/.bashrc


Test the installation

You should now be able to run the hledger tools (whichever ones you installed) and see the expected versions:

$hledger --version
hledger 1.12
$hledger-ui --version
hledger-ui 1.12
$hledger web --version
hledger-web 1.12
$hledger iadd --version
This is hledger-iadd version 1.3.7

And you can check that the unit tests pass (just for fun):

$hledger test
...
✅ 188 tests passed, no failures! 👍 🎉

c. Build the development version

Also a good choice. Our master branch is stable enough for daily use, and includes the latest improvements. You’ll need git and stack or cabal. Eg, this will build and install all of the main hledger tools using stack:

git clone https://github.com/simonmichael/hledger
cd hledger
stack install

cabal users may find the cabal-install.sh or cabal.project files useful.

See the troubleshooting, PATH, and test tips above. Note development builds will have a .99 suffix (eg 1.12.99 means “1.13-dev”).