ghcup

Go to file

Julian Ospald 5bb5389192 Make uninstallation more robust For an incomplete installation, we still want to remove what is left over, so don't fail on non-existing symlinks in $BIN_LOCATION.		2018-10-27 14:45:14 +08:00
.travis.sh	Add a debug-info subcommand	2018-10-17 21:01:40 +08:00
.travis.yml	Fix travis	2018-10-09 00:24:58 +08:00
COPYING	License this project BSD-3	2018-09-29 23:33:16 +08:00
ghcup	Make uninstallation more robust	2018-10-27 14:45:14 +08:00
README.md	Simplify installation	2018-10-20 09:46:58 +08:00

README.md

ghcup makes it easy to install specific versions of ghc on GNU/Linux, and can also bootstrap a fresh Haskell developer environment from scratch. It follows the unix UNIX philosophy of do one thing and do it well.

Similar in scope to rustup, pyenv and jenv.

OS X users may prefer futurice and Ubuntu users may prefer hvr's ppa.

Installation
Usage
How
Contributing
Known problems

Installation

Just place the ghcup shell script into your PATH anywhere.

E.g.:

( mkdir -p ~/.ghcup/bin && curl https://raw.githubusercontent.com/haskell/ghcup/master/ghcup > ~/.ghcup/bin/ghcup && chmod +x ~/.ghcup/bin/ghcup) && echo "Success"

Then adjust your PATH in ~/.bashrc (or similar, depending on your shell) like so, for example:

export PATH="$HOME/.cabal/bin:$HOME/.ghcup/bin:$PATH"

Usage

See ghcup --help.

Generally this is meant to be used with cabal-install, which handles your haskell packages and can demand that a specific version of ghc is available, which ghcup can do.

How

Installs a specified GHC version into ~/.ghcup/ghc/<ver>, and places ghc-<ver> symlinks in ~/.ghcup/bin/.

Optionally, an unversioned ghc link can point to a default version of your choice.

This uses precompiled GHC binaries that have been compiled on fedora/debian by upstream GHC.

Alternatively, you can also tell it to compile from source (note that this might fail due to missing requirements).

In addition this script can also install cabal-install.

Contributing

PR or email
this script is POSIX shell
use shellcheck and checkbashisms.pl from debian devscripts
whitespaces, no tabs

Known problems

Limited distributions supported

Currently only GNU/Linux distributions compatible with the upstream GHC binaries are supported.

Precompiled binaries

Since this uses precompiled binaries you may run into problems with ncurses and missing libtinfo, in case your distribution doesn't use the legacy way of building ncurses and has no compatibility symlinks in place.

Ask your distributor on how to solve this or try to compile from source via ghcup compile <version>.

Unreliable download location

There is no single reliable URL where to download future GHC binary releases from, since the tarball names contain the distro name and version they were built on. As such, we cannot foresee what will be the next tarball name.

In such a case, consider to update this script via ghcup self-update.

Compilation

Although this script can compile GHC for you, it's just a very thin wrapper around the build system. It makes no effort in trying to figure out whether you have the correct toolchain and the correct dependencies. Refer to the official docs on how to prepare your environment for building GHC.