223 lines
11 KiB
Markdown
223 lines
11 KiB
Markdown
# Download
|
|
|
|
There are several ways to install hledger:
|
|
|
|
a. [Download the binary or system package for your platform](#a.-download-a-binary-or-system-package) (quick install, often not up to date)
|
|
b. [Build the latest release with hledger-install](#b.-build-the-latest-release)
|
|
or [with stack](#b2.-with-stack)
|
|
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)
|
|
|
|
|
|
<a name="a"></a>
|
|
|
|
## a. Download a binary or system package for your platform
|
|
|
|
<style>
|
|
table { margin-left:1em; }
|
|
tr { border-top:thin solid #ddd; border-bottom:thin solid #ddd; }
|
|
div > p > strong > code { margin-left:1em; } /* top-level code lines */
|
|
code { white-space:nowrap; }
|
|
tr { vertical-align:top; }
|
|
td { padding-bottom:.5em; padding-right:1em; }
|
|
td:first-of-type {
|
|
/* white-space:nowrap; */
|
|
/* width:1%; */
|
|
}
|
|
a { white-space:nowrap; }
|
|
.warnings {
|
|
display:inline-block;
|
|
margin-left:1em;
|
|
font-style:italic;
|
|
font-size:small;
|
|
}
|
|
.warnings > a:before {
|
|
content: " ⚠ ";
|
|
color:red;
|
|
}
|
|
</style>
|
|
|
|
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<br>([as of 20181006](https://repology.org/metapackage/hledger/badges), latest is [1.11](http://hledger.org/release-notes))
|
|
|----------------------|------------------------|----------------------------------------------------------------------------------------
|
|
| 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
|
|
| CentOS | <span class=warnings>?</span> |
|
|
| 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
|
|
| |
|
|
| 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)
|
|
| 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
|
|
|
|
|
|
<a name="b"></a>
|
|
|
|
## b. Build the latest release
|
|
|
|
Good choice! You'll get the latest features and fixes mentioned in the [release notes](release-notes.html),
|
|
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-devel`** <!-- https://github.com/simonmichael/hledger/issues/715 -->
|
|
| Debian, Ubuntu: | **`sudo apt install -y libtinfo-dev`**
|
|
| Fedora, RHEL: | **`sudo dnf install -y gmp-devel ncurses-devel`**
|
|
|
|
- Here are some known build issues and workarounds on certain platforms:
|
|
|
|
<span class=warnings>
|
|
[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) -->
|
|
[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)\
|
|
[windows: hledger-ui is not available](https://github.com/jtdaugherty/vty/pull/1#issuecomment-297143444)\
|
|
</span>
|
|
|
|
|
|
<div style="margin-left:1em; margin-bottom:2em;">
|
|
|
|
<a name="b1"></a>
|
|
|
|
### 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](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:
|
|
|
|
**`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`**
|
|
|
|
<a name="b2"></a>
|
|
|
|
### b2. with stack
|
|
|
|
[`stack`](http://haskell-lang.org/get-started) 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](https://github.com/simonmichael/hledger/issues/275#issuecomment-123834252).
|
|
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](/hledger.html#third-party-add-ons)
|
|
like
|
|
[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:
|
|
|
|
**`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](http://paste.hledger.org) & [IRC](http://irc.hledger.org),
|
|
or the [issue tracker](http://bugs.hledger.org),
|
|
or [email](docs.html#helpfeedback).
|
|
|
|
|
|
|
|
<a name="b3"></a>
|
|
|
|
### b3. with cabal
|
|
|
|
[cabal](https://www.haskell.org/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`**\
|
|
|
|
</div>
|
|
|
|
#### 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! 👍 🎉`\
|
|
|
|
|
|
|
|
<a name="c"></a>
|
|
|
|
## c. Build the development version
|
|
|
|
Also a good choice. Our master branch is stable enough for daily use,
|
|
and includes the [latest improvements](https://github.com/simonmichael/hledger/commits/master).
|
|
You'll need [git](https://en.wikipedia.org/wiki/Git) and
|
|
[`stack`](http://haskell-lang.org/get-started) or [cabal](https://www.haskell.org/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](#b).
|
|
Note development builds will have a .99 suffix (1.11.99 means "1.12-dev").
|
|
|