ghcup

Go to file

Julian Ospald 4c548c1037 Tweak exit code for 'ghcup install' If a GHC is already installed, we shouldn't treat it as an error.		2019-01-04 13:51:29 +08:00
.github/ISSUE_TEMPLATE	Clarify log information	2018-12-15 00:35:31 +08:00
.available-versions	Improve documentation in .available-versions	2019-01-04 13:05:53 +08:00
.download-urls	Improve documentation in .download-urls	2019-01-04 13:03:26 +08:00
.travis.sh	Fix check_meta_file_version calls	2018-11-06 16:27:27 +08:00
.travis.yml	Drop unused fast_finish: true from .travis.yml	2018-12-11 22:13:33 +00:00
CONTRIBUTING.md	Add CONTRIBUTING.md	2018-10-30 21:21:43 +08:00
COPYING	License this project BSD-3	2018-09-29 23:33:16 +08:00
ghcup	Tweak exit code for 'ghcup install'	2019-01-04 13:51:29 +08:00
README.md	Add design goals to README	2018-11-24 19:35:17 +08:00

README.md

ghcup makes it easy to install specific versions of ghc on GNU/Linux as well as MacOS (aka Darwin), 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
Design goals
How
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.

Common use cases are:

# install the last known "best" GHC version
ghcup install
# install a specific GHC version
ghcup install 8.2.2
# set the currently "active" GHC version
ghcup set 8.4.4
# install cabal-install
ghcup install-cabal
# update cabal-install
cabal new-install cabal-install

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.

Design goals

simplicity
non-interactive
portable
do one thing and do it well (UNIX philosophy)

Non-goals

invoking sudo, apt-get or any package manager
handling system packages
handling cabal projects
being a stack alternative

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.

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>.

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.