slaesvuo/hledger
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
a57c1bde08
hledger/site/download.md
Simon Michael eab60892d3 Revert "site: download: --resolver=nightly is unneeded" 
This reverts commit 885d3778fc.
2016-12-26 05:48:51 -08:00

5.7 KiB
Raw Blame History

 

Download

A. I want to download a packaged version

Packaged versions are the quickest to install, but they sometimes lag behind the latest release, or provide only some of the hledger tools. (Packagers welcome!)

Windows: Download and run the latest development builds (-> Appveyor CI)
Mac: brew install hledger
Debian, Ubuntu: sudo apt install hledger hledger-ui hledger-web
Fedora, RHEL: sudo dnf install hledger
Gentoo: sudo layman -a haskell && sudo emerge hledger hledger-ui hledger-web
NixOS: nix-env -iA nixpkgs.haskellPackages.hledger \
  nixpkgs.haskellPackages.hledger-ui \
  nixpkgs.haskellPackages.hledger-web
Sandstorm: hledger-web Sandstorm app -> demo
(your own fully-functional private/public hledger-web instance in 3 clicks)

B. I want to build the latest release

The latest release (see release notes) is a good choice. You have to build it, but that’s pretty easy.

  1. Install stack. On Windows, the 64-bit version is recommended. On Arch, you may need to also install GHC manually.

  2. stack install --resolver=nightly hledger [hledger-ui] [hledger-web] [hledger-api]
    On Windows, hledger-ui is not yet available.
    If stack says you need to run stack setup, do that first.
    Warnings about “No packages found in snapshot which provide a”hsc2hs” executable” can be ignored.
    If required C libraries (like curses) are not installed, you might need to install those manually and try again, eg:

    Debian, Ubuntu: sudo apt install libncurses5-dev
    Fedora, RHEL: sudo dnf install ncurses-devel

  3. If stack warns that ~/.local/bin (or the Windows equivalent) is not in $PATH, fix that. Eg if you’re a bash user:
    echo "export PATH=$PATH:~/.local/bin" >> ~/.bashrc && source ~/.bashrc
    Now you can run hledger --version, hledger-ui --version etc.

Installing with cabal is similar, if you’re familiar with that.

C. I want to build the development version

The dev version includes not-yet-released features and is stable enough for daily use.

  1. Install stack and git

  2. git clone http://code.hledger.org hledger

  3. cd hledger

  4. stack install
    with the same caveats as mentioned above:

    • if stack says you need to run stack setup, do that first,
    • if building fails due to missing C libs, install those first
    • if stack warns that ~/.local/bin (or the Windows equivalent) is not in $PATH, fix that
    • warnings about “No packages found in snapshot which provide a hsc2hs executable” can be ignored

Cabal users can use the cabal-install.sh or cabal.project files instead.