2015-11-04 05:59:12 +03:00
# Download
2015-11-10 01:10:59 +03:00
2018-10-06 22:12:55 +03:00
There are several ways to install hledger:
2018-10-06 20:57:50 +03:00
2018-10-06 22:12:55 +03:00
a. [Download the binary or system package for your platform ](#a.-download-a-binary-or-system-package ) (quick install, often not up to date)
2018-10-06 20:57:50 +03:00
b. [Build the latest release with hledger-install ](#b.-build-the-latest-release )
or [with stack ](#b2.-with-stack )
2018-10-06 22:12:55 +03:00
or [with cabal ](#b3.-with-cabal ) (slow install, up to date)
c. [Build the development version with stack or cabal ](#c.-build-the-development-version ) (slow install, super-fresh)
2018-10-06 20:57:50 +03:00
2017-04-28 17:38:59 +03:00
< a name = "a" > < / a >
2017-04-13 18:42:24 +03:00
2018-10-06 22:12:55 +03:00
## a. Download a binary or system package for your platform
2014-11-05 08:18:13 +03:00
2015-07-23 17:05:28 +03:00
< style >
2018-03-10 16:10:23 +03:00
table { margin-left:1em; }
2018-10-06 22:12:55 +03:00
tr { border-top:thin solid #ddd ; border-bottom:thin solid #ddd ; }
2018-03-11 15:25:49 +03:00
div > p > strong > code { margin-left:1em; } /* top-level code lines */
2018-03-10 17:08:32 +03:00
code { white-space:nowrap; }
2015-07-23 17:05:28 +03:00
tr { vertical-align:top; }
2016-02-21 23:39:32 +03:00
td { padding-bottom:.5em; padding-right:1em; }
2016-09-13 22:08:37 +03:00
td:first-of-type {
/* white-space:nowrap; */
/* width:1%; */
}
a { white-space:nowrap; }
2018-03-04 17:47:43 +03:00
.warnings {
2018-10-06 20:57:50 +03:00
display:inline-block;
margin-left:1em;
2018-03-04 17:47:43 +03:00
font-style:italic;
2018-10-06 20:57:50 +03:00
font-size:small;
2018-03-04 17:47:43 +03:00
}
.warnings > a:before {
2018-10-06 20:57:50 +03:00
content: " ⚠ ";
2018-03-04 17:47:43 +03:00
color:red;
}
2015-07-23 17:05:28 +03:00
< / style >
2018-10-06 20:57:50 +03:00
Binaries or system packages are quickest to install, but they can be outdated or incomplete.
(Please help/report issues to packagers.)
2018-10-06 22:12:55 +03:00
**Available binaries / system packages:**
2018-10-06 20:57:50 +03:00
2018-10-06 22:12:55 +03:00
| Platform | Command/Link | Installs version< br > ([as of 20181006](https://repology.org/metapackage/hledger/badges), latest is [1.11 ](http://hledger.org/release-notes ))
2018-10-06 20:57:50 +03:00
|----------------------|------------------------|----------------------------------------------------------------------------------------
| Mac | ** `brew install hledger` ** < br >< span class = warnings > [only hledger CLI](https://github.com/simonmichael/hledger/issues/321#issuecomment-179920520)</ span > | 1.10
| Windows | Developer binaries: ** [1.10 ](https://ci.appveyor.com/api/buildjobs/5n63x22wvd4j24ee/artifacts/hledger.zip )** <!-- or [latest nightly dev build ](https://ci.appveyor.com/api/projects/simonmichael/hledger/artifacts/hledger.zip?branch=master ) --> < br >< span class = warnings > [no hledger-ui ](https://github.com/jtdaugherty/vty/pull/1#issuecomment-297143444 ),[doesn't work on old windows ?](https://github.com/simonmichael/hledger/issues/774),[many files in PATH causing hangs](https://github.com/simonmichael/hledger/issues/791)<!-- ,[appveyor builds failing](https://github.com/simonmichael/hledger/issues/832) --> </ span > | 1.10
| |
| Arch Linux | ** `pacman -S hledger` ** | 1.11
| 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` ** < span class = warnings > ?</ span > | < span class = warnings > ?</ span >
| 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 | < span class = warnings > ?< / span > |
| NetBSD | < span class = warnings > ?< / span > |
| OpenBSD | Ports: ** [https://github.com/jasperla/openbsd-wip/pull/104 ](https://github.com/jasperla/openbsd-wip/pull/104 )** < br > Third-party binaries: ** [OpenBSD6.3/amd64 ](https://s3.amazonaws.com/openbsd-hledger/index.html )** | 1.10
| |
2018-10-06 22:12:55 +03:00
| NixOS | ** < span style = "font-size:small;" > `nix-env -iA nixpkgs.haskellPackages.hledger nixpkgs.haskellPackages.hledger-ui nixpkgs.haskellPackages.hledger-web`</ span > ** < br >< span class = warnings > [problems with hledger-ui on Mac ?](https://github.com/simonmichael/hledger/issues/613)</ span > | 1.5 (stable), 1.11 (unstable)
2018-10-06 20:57:50 +03:00
| Sandstorm | ** [hledger-web Sandstorm app ](https://apps.sandstorm.io/app/8x12h6p0x0nrzk73hfq6zh2jxtgyzzcty7qsatkg7jfg2mzw5n90 )** < br >< span class = warnings > [features needed](https://github.com/simonmichael/hledger/issues/425)</ span > | 1.9.2
2014-11-13 05:02:40 +03:00
2016-10-30 17:10:35 +03:00
2016-10-30 16:38:33 +03:00
< a name = "b" > < / a >
2015-11-10 01:10:59 +03:00
2018-10-06 22:12:55 +03:00
## b. Build the latest release
2014-11-11 00:38:05 +03:00
2018-03-10 17:08:32 +03:00
Good choice! You'll get the latest features mentioned in the [release notes ](release-notes.html ).
Below are three ways to build the latest release, in order of preference.
2018-01-22 23:25:20 +03:00
2018-03-10 16:10:23 +03:00
Note, building all hledger tools for the first time could take as much
2018-05-17 04:43:40 +03:00
as an hour, 1G of free memory, and 1G of disk space.
(We're not bloated; we just sit atop a lot of fine Haskell engineering!)
You can kill and restart it without losing progress, and subsequent builds will be much faster.
2018-03-10 16:10:23 +03:00
Also, here are some known build issues and workarounds:\
2018-03-04 17:47:43 +03:00
< span class = warnings >
2018-04-28 22:13:06 +03:00
[arch: advice from Arch wiki ](https://wiki.archlinux.org/index.php/Haskell )\
[arch: No information found for ghc-8.4.2 ](https://github.com/commercialhaskell/stack/issues/3984 )\
<!-- [arch: some past problems ](https://github.com/simonmichael/hledger/issues/668 ) -->
2018-03-10 16:10:23 +03:00
[freebsd 12: no cabal file found ](https://github.com/simonmichael/hledger/issues/709 )\
[openbsd 6: exec permission denied ](https://deftly.net/posts/2017-10-12-using-cabal-on-openbsd.html )\
[openbsd: how to get stack ](https://github.com/commercialhaskell/stack/issues/2822#issuecomment-318892816 )\
2018-03-04 17:47:43 +03:00
< / span >
2018-01-22 23:14:20 +03:00
2018-04-28 22:34:59 +03:00
< a name = "b1" > < / a >
### b1. with hledger-install
2018-01-22 23:14:20 +03:00
2018-10-07 02:16:36 +03:00
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 ](https://github.com/simonmichael/hledger/tree/master/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.
2018-02-17 15:23:15 +03:00
2018-10-07 02:16:36 +03:00
** `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` **
2018-03-10 16:10:23 +03:00
#### Link errors ?
If you see link errors (like "/bin/ld.gold: error: cannot find -ltinfo"),
2018-06-06 18:07:00 +03:00
you might need to install some extra system packages, such as the below, and try again.
Please do a web search for the error and send corrections for this list:
2018-03-10 16:10:23 +03:00
|
|-----------------|-------------------------------------------------------
| Centos: | ** `sudo yum install -y libstdc++-devel ncurses-devel zlib-devel` ** *# [?](https://github.com/simonmichael/hledger/issues/715)*
2018-06-06 18:07:00 +03:00
| Debian, Ubuntu: | ** `sudo apt install -y libtinfo-dev` ** *# ?*
2018-07-16 06:57:19 +03:00
| Fedora, RHEL: | ** `sudo dnf install -y gmp-devel ncurses-devel` ** *# ?*
2017-07-21 11:33:07 +03:00
2018-03-10 16:10:23 +03:00
#### Set up $PATH
2018-03-07 21:15:55 +03:00
2018-03-10 16:10:23 +03:00
You should
[extend your \$PATH with `~/.local/bin` ](https://docs.haskellstack.org/en/stable/install_and_upgrade/#path ) (for stack)
and/or `~/.cabal/bin` (for cabal).
2018-03-10 17:08:32 +03:00
Eg, if you use bash:
2018-03-10 16:10:23 +03:00
**`echo "export PATH=~/.local/bin:~/.cabal/bin:$PATH" >> ~/.bashrc & & source ~/.bashrc`**
2018-03-10 17:08:32 +03:00
#### Test
Now you should be able to run the hledger tools and see the expected versions. Eg:
2018-03-11 15:25:49 +03:00
```shell
2018-03-10 17:08:32 +03:00
$ hledger --version
2018-10-01 09:36:56 +03:00
hledger 1.11
2018-03-10 17:08:32 +03:00
$ hledger-ui --version
2018-10-01 09:36:56 +03:00
hledger-ui 1.11
2018-03-10 17:08:32 +03:00
$ hledger web --version
2018-10-01 09:36:56 +03:00
hledger-web 1.11
2018-03-10 17:08:32 +03:00
$ hledger iadd --version
2018-10-01 09:36:56 +03:00
This is hledger-iadd version 1.3.6
2018-03-10 17:08:32 +03:00
```
2018-03-10 16:10:23 +03:00
#### Need help ?
2018-03-10 17:08:32 +03:00
If you are having trouble, please capture a debug log and send it to me via
2018-02-17 15:23:15 +03:00
[paste ](http://paste.hledger.org ) & [IRC ](http://irc.hledger.org ),
2018-03-10 16:10:23 +03:00
the [issue tracker ](http://bugs.hledger.org ),
2018-02-17 15:23:15 +03:00
or [email ](docs.html#helpfeedback ):
2017-07-21 11:33:07 +03:00
2018-02-17 15:23:15 +03:00
** `bash -x hledger-install.sh 2>&1 | tee hledger-install.log` **
2017-07-21 11:33:07 +03:00
2018-04-28 22:34:59 +03:00
< a name = "b2" > < / a >
### b2. with stack
2018-01-22 23:14:20 +03:00
2018-10-07 02:16:36 +03:00
[`stack` ](http://haskell-lang.org/get-started ) is the more reliable of the two Haskell build tools for new users.
Here's how to use it directly:
2017-07-21 11:33:07 +03:00
2018-10-07 02:16:36 +03:00
- Use stack 1.7.1 or newer. The latest release is best.
On Windows, the 64-bit version of stack is [preferred ](https://github.com/simonmichael/hledger/issues/275#issuecomment-123834252 ).
2018-01-22 23:14:20 +03:00
2018-10-07 02:16:36 +03:00
- **`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`**\
This installs the main hledger packages from [Stackage ](https://www.stackage.org ) and/or [Hackage ](http://hackage.haskell.org ).
2018-07-15 17:48:57 +03:00
To estimate the build time, add `--dry-run` .
2018-10-07 02:16:36 +03:00
You can save some time by omitting hledger-ui, hledger-web and/or hledger-api.
You can kill and restart this without losing progress.
< span class = warnings > ([windows: hledger-ui is not available](https://github.com/jtdaugherty/vty/pull/1#issuecomment-297143444))< / span >
2018-03-10 16:10:23 +03:00
2018-10-07 02:16:36 +03:00
- As above: ** [If you see link errors.. ](#link-errors )**, ** [Set up \$PATH ](#set-up-path )**, and ** [Test ](#test )**
2018-03-10 16:10:23 +03:00
2018-10-07 02:16:36 +03:00
< a name = "b3" > < / a >
2018-03-10 16:10:23 +03:00
2018-10-07 02:16:36 +03:00
### b3. with cabal
2018-01-22 23:14:20 +03:00
2018-10-07 02:16:36 +03:00
[cabal ](https://www.haskell.org/cabal/ ) is the other Haskell build tool. If you're a cabal expert, feel free to use it in the usual way, eg:
2018-01-22 23:14:20 +03:00
2018-10-07 02:16:36 +03:00
- **`cabal update && cabal install hledger-1.11 [hledger-ui-1.11] [hledger-web-1.11] [hledger-api-1.11]`**
2018-04-28 22:34:59 +03:00
2018-10-07 02:16:36 +03:00
- **[If you see link errors..](#link-errors)**, ** [Set up \$PATH ](#set-up-path )**, and ** [Test ](#test )**, as above.
2016-09-13 19:00:17 +03:00
2018-10-07 02:16:36 +03:00
\
Additional [add-on commands ](/hledger.html#third-party-add-ons )
such as
[hledger-diff ](http://hackage.haskell.org/package/hledger-diff ),
[hledger-iadd ](http://hackage.haskell.org/package/hledger-iadd ),
or [hledger-interest ](http://hackage.haskell.org/package/hledger-interest )
can be installed similarly using stack or cabal.
2015-07-14 07:56:39 +03:00
2016-10-30 16:38:33 +03:00
< a name = "c" > < / a >
2016-09-13 19:00:17 +03:00
2018-10-06 22:12:55 +03:00
## c. Build the development version
2016-09-13 19:00:17 +03:00
2018-03-10 16:10:23 +03:00
Also a good choice. Our master branch is stable enough for daily use,
2018-03-10 17:08:32 +03:00
and includes the [latest improvements ](https://github.com/simonmichael/hledger/commits/master ).
2016-09-13 19:00:17 +03:00
2018-05-25 17:20:57 +03:00
1. **Install [git](https://en.wikipedia.org/wiki/Git) and [`stack`](#b2)**
2017-12-22 17:40:44 +03:00
2. ** `git clone https://github.com/simonmichael/hledger` **
2017-04-02 21:10:58 +03:00
3. ** `cd hledger` **
2018-04-09 03:53:23 +03:00
4. ** `stack install [hledger]` ** *# build all (or, just the command line UI)*
2018-03-10 17:08:32 +03:00
5. ** [If you see link errors.. ](#link-errors )**
2018-03-10 16:10:23 +03:00
6. ** [Set up \$PATH ](#set-up-path )**
2018-03-10 17:08:32 +03:00
7. ** [Test ](#test )**
2018-07-01 00:13:01 +03:00
(Development versions will have a .99 suffix, 1.10.99 means 1.11-dev)
2017-01-08 22:00:10 +03:00
2018-01-22 23:14:20 +03:00
cabal users may find the `cabal-install.sh` or `cabal.project` files useful.