ghcup: ghc toolchain installer

[ lgpl, library, program, system ] [ Propose Tags ]

A rewrite of the shell script ghcup, for providing a more stable user experience and exposing an API.


[Skip to Readme]
Versions [faq] 0.1.14.1, 0.1.14.2
Change log CHANGELOG.md
Dependencies aeson (>=1.4 && <1.6), aeson-pretty (>=0.8.8 && <0.9), async (>=0.8 && <2.3), base (>=4.13 && <5), base16-bytestring (>=0.1.1.6 && <1.1), binary (>=0.8.6.0 && <0.9), bytestring (==0.10.*), bz2 (>=0.5.0.5 && <1.1), case-insensitive (>=1.2.1.0 && <1.3), casing (>=0.1.4.1 && <0.2), concurrent-output (>=1.10.11 && <1.11), containers (==0.6.*), cryptohash-sha256 (>=0.11.101.0 && <0.12), generics-sop (==0.5.*), ghcup, haskus-utils-types (==1.5.*), haskus-utils-variant (>=3.0 && <3.2), hpath (>=0.11 && <0.13), hpath-directory (>=0.14.1 && <0.15), hpath-filepath (>=0.10.3 && <0.11), hpath-io (>=0.14.1 && <0.15), hpath-posix (>=0.13.2 && <0.14), libarchive (>=3.0.0.0 && <3.1), lzma-static (>=5.2.5.2 && <5.3), megaparsec (>=8.0.0 && <9.1), monad-logger (>=0.3.31 && <0.4), mtl (==2.2.*), optics (>=0.2 && <0.5), optics-vl (==0.2.*), optparse-applicative (>=0.15.1.0 && <0.17), os-release (>=1.0.0 && <1.1), parsec (==3.1.*), pretty (>=1.1.3.1 && <1.2), pretty-terminal (>=0.1.0.0 && <0.2), regex-posix (==0.96.*), resourcet (>=1.2.2 && <1.3), safe (>=0.3.18 && <0.4), safe-exceptions (==0.1.*), split (>=0.2.3.4 && <0.3), streamly (>=0.7.3 && <0.8), streamly-bytestring (>=0.1.2 && <0.2), streamly-posix (>=0.1.0.0 && <0.2), strict-base (==0.4.*), string-interpolate (>=0.2.0.0 && <0.4), template-haskell (>=2.7 && <2.17), text (>=1.2.4.0 && <1.3), time (>=1.9.3 && <1.10), transformers (==0.5.*), unix (==2.7.*), unix-bytestring (==0.3.*), unordered-containers (>=0.2.10.0 && <0.3), uri-bytestring (>=0.3.2.2 && <0.4), utf8-string (==1.0.*), vector (==0.12.*), versions (>=4.0.1 && <4.1), vty (>=5.28.2 && <5.34), word8 (>=0.1.3 && <0.2), yaml (>=0.11.4.0 && <0.12), zlib (>=0.6.2.2 && <0.7) [details]
License LGPL-3.0-only
Copyright Julian Ospald 2020
Author Julian Ospald
Maintainer hasufell@posteo.de
Category System
Home page https://gitlab.haskell.org/haskell/ghcup-hs
Bug tracker https://gitlab.haskell.org/haskell/ghcup-hs/issues
Source repo head: git clone https://gitlab.haskell.org/haskell/ghcup-hs.git
Uploaded by maerwald at 2021-05-12T11:41:13Z
Distributions NixOS:0.1.14.1
Executables ghcup-gen, ghcup
Downloads 62 total (39 in the last 30 days)
Rating 2.0 (votes: 1) [estimated by Bayesian average]
Your Rating
  • λ
  • λ
  • λ
Status Hackage Matrix CI
Docs uploaded by user
Build status unknown [no reports yet]

Modules

[Index] [Quick Jump]

Flags

NameDescriptionDefaultType
tui

Build the brick powered tui (ghcup tui)

DisabledManual
internal-downloader

Compile the internal downloader, which links against OpenSSL

DisabledManual
tar

Use tar-bytestring instead of libarchive

DisabledManual

Use -f <flag> to enable a flag, or -f -<flag> to disable that flag. More info

Downloads

Maintainer's Corner

For package maintainers and hackage trustees


Readme for ghcup-0.1.14.2

[back to package description]

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.

Similar in scope to rustup, pyenv and jenv.

Ubuntu users may prefer hvr's ppa.

Table of Contents

Installation

Simple bootstrap

Follow the instructions at https://www.haskell.org/ghcup/

Manual install

Download the binary for your platform at https://downloads.haskell.org/~ghcup/ and place it into your PATH anywhere.

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

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

Vim integration

See ghcup.vim.

Usage

See ghcup --help.

For the simple interactive TUI, run:

ghcup tui

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

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.

Configuration

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.

Manpages

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

Shell completions are in shell-completions.

For bash: install shell-completions/bash as e.g. /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).

Cross support

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. See ghcup compile ghc --help for further information.

XDG support

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 ghcup/ghc subdir (default: ~/.local/share)
  • XDG_CACHE_HOME: logs and download files will be stored in ghcup subdir (default: ~/.cache)
  • XDG_BIN_HOME: binaries end up here (default: ~/.local/bin)
  • XDG_CONFIG_HOME: the config file is stored in ghcup subdir as config.yaml (default: ~/.config)

Env variables

This is the complete list of env variables that change GHCup behavior:

  • GHCUP_USE_XDG_DIRS: see XDG support above
  • TMPDIR: where ghcup does the work (unpacking, building, ...)
  • GHCUP_INSTALL_BASE_PREFIX: the base of ghcup (default: $HOME)
  • GHCUP_CURL_OPTS: additional options that can be passed to curl
  • GHCUP_WGET_OPTS: additional options that can be passed to wget
  • CC/LD etc.: full environment is passed to the build system when compiling GHC via GHCup

Installing custom bindists

There are a couple of good use cases to install custom bindists:

  1. manually built bindists (e.g. with patches)
    • example: 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
  2. GHC head CI bindists
    • example: 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
  3. DWARF bindists
    • example: 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, 8.10.2-eff and head are both valid versions and produce the binaries ghc-8.10.2-eff and ghc-head respectively. GHCup always needs to know which version the bindist corresponds to (this is not automatically detected).

Design goals

  1. simplicity
  2. non-interactive
  3. portable (eh)
  4. do one thing and do it well (UNIX philosophy)

Non-goals

  1. invoking sudo, apt-get or any package manager
  2. handling system packages
  3. handling cabal projects
  4. 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 users

Known problems

Custom ghc version names

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.

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

Missing libtinfo (ncurses)

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

Libnuma required

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.

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.

FAQ

  1. Why reimplement stack?

ghcup is not a reimplementation of stack. The only common part is automatic installation of GHC, but even that differs in scope and design.

  1. Why not support windows?

Consider using Chocolatey or ghcups.

  1. Why the haskell reimplementation?

Why not?