|Julian Ospald 3e841b3c68||2 years ago|
|.gitlab||2 years ago|
|.travis||2 years ago|
|3rdparty||2 years ago|
|app||2 years ago|
|golden||2 years ago|
|lib||2 years ago|
|shell-completions||2 years ago|
|test||2 years ago|
|www||2 years ago|
|.gitignore||2 years ago|
|.gitlab-ci.yml||2 years ago|
|.travis.yml||2 years ago|
|CHANGELOG.md||2 years ago|
|HACKING.md||2 years ago|
|LICENSE||2 years ago|
|README.md||2 years ago|
|RELEASING.md||2 years ago|
|Setup.hs||2 years ago|
|TODO.md||2 years ago|
|bootstrap-haskell||2 years ago|
|cabal.ghc884.project||2 years ago|
|cabal.ghc884.project.freeze||2 years ago|
|cabal.project||2 years ago|
|config.yaml||2 years ago|
|ghcup-0.0.2.yaml||2 years ago|
|ghcup-0.0.3.yaml||2 years ago|
|ghcup.cabal||2 years ago|
|hie.yaml||2 years ago|
|stack.yaml||2 years ago|
ghcup makes it easy to install specific versions of
ghc on GNU/Linux,
macOS (aka Darwin) and FreeBSD 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.
Ubuntu users may prefer hvr’s ppa.
Follow the instructions at https://www.haskell.org/ghcup/
Download the binary for your platform at https://downloads.haskell.org/~ghcup/
and place it into your
Then adjust your
~/.bashrc (or similar, depending on your shell) like so:
For the simple interactive TUI, run:
For the full functionality via cli:
# list available ghc/cabal versions ghcup list # install the recommended GHC version ghcup install ghc # install a specific GHC version ghcup install ghc 8.2.2 # set the currently "active" GHC version ghcup set ghc 8.4.4 # install cabal-install ghcup install cabal # update ghcup itself ghcup upgrade
A configuration file can be put in
~/.ghcup/config.yaml. The default config file
explaining all possible configurations can be found in this repo: config.yaml.
Partial configuration is fine. Command line options always overwrite the config file settings.
For man pages to work you need man-db as your
man provider, then issue
man ghc. Manpages only work for the currently set ghc.
MANPATH may be required to be unset.
Shell completions are in
For bash: install
/etc/bash_completion.d/ghcup (depending on distro)
and make sure your bashrc sources the startup script
/usr/share/bash-completion/bash_completion on some distros).
ghcup can compile and install a cross GHC for any target. However, this requires that the build host has a complete cross toolchain and various libraries installed for the target platform.
Consult the GHC documentation on the prerequisites.
For distributions with non-standard locations of cross toolchain and
libraries, this may need some tweaking of
build.mk or configure args.
ghcup compile ghc --help for further information.
To enable XDG style directories, set the environment variable
GHCUP_USE_XDG_DIRS to anything.
Then you can control the locations via XDG environment variables as such:
XDG_DATA_HOME: GHCs will be unpacked in
XDG_CACHE_HOME: logs and download files will be stored in
XDG_BIN_HOME: binaries end up here (default:
There are a couple of good use cases to install custom bindists:
ghcup install ghc -u 'file:///home/mearwald/tmp/ghc-eff-patches/ghc-8.10.2-x86_64-deb10-linux.tar.xz' 8.10.2-eff
ghcup install ghc -u 'https://gitlab.haskell.org/api/v4/projects/1/jobs/artifacts/master/raw/ghc-x86_64-fedora27-linux.tar.xz?job=validate-x86_64-linux-fedora27' head
ghcup install ghc -u 'https://downloads.haskell.org/~ghc/8.10.2/ghc-8.10.2-x86_64-deb10-linux-dwarf.tar.xz' 8.10.2-dwarf
Since the version parser is pretty lax,
head are both valid versions
and produce the binaries
GHCup always needs to know which version the bindist corresponds to (this is not automatically
apt-getor any package manager
Installs a specified GHC version into
~/.ghcup/ghc/<ver>, and places
ghc-<ver> symlinks in
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
When installing ghc bindists with custom version names as outlined in
installing custom bindists, then cabal might
be unable to find the correct
ghc-pkg (also see #73)
if you use
cabal build --with-compiler=ghc-foo. Instead, point it to the full path, such as:
cabal build --with-compiler=$HOME/.ghcup/ghc/<version-name>/bin/ghc or set that GHC version
as the current one via:
ghcup set ghc <version-name>.
This problem doesn’t exist for regularly installed GHC versions.
Currently only GNU/Linux distributions compatible with the upstream GHC binaries are supported.
Since this uses precompiled binaries you may run into several problems.
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>.
This was a bug in the build system of some GHC versions that lead to unconditionally enabled libnuma support. To mitigate this you might have to install the libnuma package of your distribution. See here for a discussion.
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.
ghcup is not a reimplementation of stack. The only common part is automatic installation of GHC, but even that differs in scope and design.