simonmichael/hledger
1
1
Fork 0
mirror of https://github.com/simonmichael/hledger.git synced 2024-09-20 10:47:29 +03:00
Code Issues Projects Releases Wiki Activity
27f9b0b000
hledger/site/download.md
Simon Michael 27f9b0b000 doc, site: announcement, download page updates 
The latest install instructions, 2016/10 edition.

[ci skip]
2016-10-30 06:38:33 -07:00

5.7 KiB
Raw Blame History

 
# Download

A. I want to download a packaged version

Packaged versions may lag behind the latest release, but are the quickest to install.
Windows: Download and run hledger-0.26-win64.exe & hledger-web-0.26-win64.exe (old), or the latest development builds. hledger-ui does not run on Windows.
Mac: brew install hledger
hledger-ui/web/api have not yet been added to homebrew.
Debian, Ubuntu: sudo apt install hledger hledger-ui hledger-web
Fedora, RHEL: sudo dnf install hledger
hledger-ui/web/api have not yet been added to Fedora.
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

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.

  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

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

The same caveats as above apply:

  • 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