11 KiB
Download
There are several ways to install hledger:
- Download the binary or system package for your platform (quick install, often not up to date)
- Build the latest release with hledger-install or with stack or with cabal (slow install, up to date)
- Build the development version with stack or cabal (slow install, super-fresh)
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. (Please help/report issues to packagers.)
Available binaries / system packages:
| Platform | Command/Link | Installs version (as of 20181006, latest is 1.11) |
|---|---|---|
| Mac | brew install hledger only hledger CLI |
1.10 |
| Windows | Developer binaries: 1.10
no hledger-ui,doesn’t work on old windows ?,many files in PATH causing hangs |
1.10 |
| Arch Linux | pacman -S hledger |
1.11 |
| CentOS | ? | |
| Debian | sudo apt install hledger hledger-ui hledger-web |
1.0.1 (Stable), 1.5 (Testing), 1.10 (Unstable) |
| Fedora | sudo dnf install hledger |
1.2 (27), 1.4 (28), 1.5 (Rawhide) |
| Gentoo | sudo layman -a haskell && sudo emerge hledger hledger-ui hledger-web |
1.11 |
| RHEL | sudo dnf install hledger ? |
? |
| Ubuntu | sudo apt install hledger hledger-ui hledger-web |
0.26 (16.04 Xenial), 1.2 (18.04 Bionic), 1.5 (18.10 Cosmic) |
| 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 |
| NixOS | nix-env -iA nixpkgs.haskellPackages.hledger nixpkgs.haskellPackages.hledger-ui nixpkgs.haskellPackages.hledger-web
problems with hledger-ui on Mac ? |
1.5 (stable), 1.11 (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. Here are some tips, just in case you need them:
Building all of hledger for the first time could take as much as an hour, 1-2G of free memory, and 1-2G of disk space. (We make use of a lot of fine Haskell software.) You can kill and restart the build without losing progress, and future builds will be much faster.
If building fails with link errors (eg: “/bin/ld.gold: error: cannot find -ltinfo”), you might need to install some extra system packages and try again. Check the list below, or do a web search for the error message to find the required package (and please send updates for this list):
CentOS: sudo yum install -y libstdc++-devel ncurses-devel zlib-develDebian, Ubuntu: sudo apt install -y libtinfo-devFedora, RHEL: sudo dnf install -y gmp-devel ncurses-develHere are some known build issues and workarounds on certain platforms:
arch: advice from Arch wiki
arch: No information found for ghc-8.4.2
freebsd 12: no cabal file found
openbsd 6: exec permission denied
openbsd: how to get stack
windows: hledger-ui is not available
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
must use stack 1.7.1 or newer; the latest release is best. On Windows,
the 64-bit version of stack is preferred.
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 cassava-megaparsec-1.0.0 hledger-lib-1.11 hledger-1.11 hledger-ui-1.11 hledger-web-1.11 hledger-api-1.11
Other add-ons like hledger-diff, hledger-iadd, or hledger-interest can be installed similarly:
stack install --resolver=lts-12 cassava-megaparsec-1.0.0 hledger-lib-1.11 hledger-1.11 hledger-ui-1.11 hledger-diff-0.2.0.14 hledger-iadd-1.3.6 hledger-interest-1.5.2
If you have trouble, please send me a copy/paste of the output, including the commands you typed, at least up to the first error, via paste & IRC, or the issue tracker, or email.
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.11 hledger-ui-1.11 hledger-web-1.11 hledger-api-1.11
Set up PATH
After installation, make sure the install directory is in your $PATH, preferably near the start. You will probably see a warning or informational message about this. 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 |
So eg if you use bash, this would 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.11
$hledger-ui --version
hledger-ui 1.11
$hledger web --version
hledger-web 1.11
$hledger iadd --version
This is hledger-iadd version 1.3.6
And you can check that the unit tests pass (just for fun):
$hledger test
...
✅ 176 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 (1.11.99 means “1.12-dev”).