haskellstack.orgThe Haskell Tool Stack

Welcome! Initializing search GitHub GitHub Welcome! Welcome! Table of contents How to install Stack How to upgrade Stack Quick Start guide Step 1: Start your new project Step 2: Next steps Complete guide to Stack Why Stack? Questions, feedback, and discussion How to contribute to the maintenance or development of Stack How to uninstall How to get & use Stack How to get & use Stack General guidance General guidance Install/upgrade User’s guide (introductory) FAQ Other resources Reference (advanced) Reference (advanced) Introduction Environment variables Configuration (project and global) Global flags and options bench command build command clean command config commands dot command docker commands eval command exec command ghc command ghci command haddock command hoogle command hpc command ide command init command install command list command ls command new command path command purge command query command repl command run command runghc command runhaskell command script command sdist command setup command templates command test command uninstall command unpack command update command upgrade command upload command Specific topics Specific topics Stack root Snapshot and package location Snapshot specification stack.yaml vs a Cabal file Script interpreter Docker integration Nix integration Non-standard project initialization Debugging Editor integration Stack and Visual Studio Code Developing on Windows Shell auto-completion CI Travis CI Azure CI Lock files Stack work directories How Stack works (advanced) How Stack works (advanced) Build overview Stack’s code (advanced) Stack’s code (advanced) Contributors Contributors Contributor’s guide Dev Containers Maintainers Maintainers Releases Maintainer team process Add GHC version Docker images Upgrading MSYS2 Upgrading 7-Zip HaskellStack.org Self-hosted runners Docker images Signing key Glossary Version history Table of contents How to install Stack How to upgrade Stack Quick Start guide Step 1: Start your new project Step 2: Next steps Complete guide to Stack Why Stack? Questions, feedback, and discussion How to contribute to the maintenance or development of Stack How to uninstall ¶ Welcome to the Haskell programming language and the Haskell Tool Stack (Stack)! Stack is a program for developing Haskell projects. It is aimed at Haskellers both new and experienced. It is cross-platform and aims to support fully users on Linux, macOS and Windows. Stack features: Installing the Glasgow Haskell Compiler (GHC) automatically, in an isolated location. Installing packages needed for your project. Building your project. Testing your project. Benchmarking your project. How to install Stack ¶ Stack can be installed on most Unix-like operating systems (including macOS) and Windows. It will require at least about 5 GB of disk space, for use with one version of GHC. Info In addition to the methods described below, Stack can also be installed using the separate GHCup installer for Haskell-related tools. GHCup provides Stack for some combinations of machine architecture and operating system not provided elsewhere. By default, the script to install GHCup (which can be run more than once) also configures Stack so that if Stack needs a version of GHC, GHCup takes over obtaining and installing that version. Linux macOS Windows Other/direct downloads For most Linux distributions, the easiest way to install Stack directly (rather than use GHCup) is to command: curl -sSL https://get.haskellstack.org/ | sh or: wget -qO- https://get.haskellstack.org/ | sh Note The script at get.haskellstack.org will ask for root access using sudo . It needs such access in order to use your platform’s package manager to install dependencies and to install to /usr/local/bin . If you prefer more control, follow the manual installation instructions in the install and upgrade guide . From late 2020, Apple began a transition from Mac computers with Intel processors (Intel-based Mac) to Mac computers with Apple silicon . Intel-based Apple silicon For most Intel-based Mac computers, the easiest way to install Stack directly (rather than use GHCup) is to command: curl -sSL https://get.haskellstack.org/ | sh or: wget -qO- https://get.haskellstack.org/ | sh Note The script at get.haskellstack.org will ask for root access using sudo . It needs such access in order to use your platform’s package manager to install dependencies and to install to /usr/local/bin . If you prefer more control, follow the manual installation instructions in the install and upgrade guide . Mac computers with Apple silicon have an M1, M1 Pro, M1 Max, M1 Ultra or M2 chip. These chips use an architecture known as ARM64 or AArch64. For Mac computers with Apple silicon, the easiest way to install Stack directly (rather than use GHCup) is to command: curl -sSL https://get.haskellstack.org/ | sh or: wget -qO- https://get.haskellstack.org/ | sh Note The script at get.haskellstack.org will ask for root access using sudo . It needs such access in order to use your platform’s package manager to install dependencies and to install to /usr/local/bin . If you prefer more control, follow the manual installation instructions in the install and upgrade guide . On 64-bit Windows, the easiest way to install Stack directly (rather than use GHCup) is to download and install the Windows installer . Info By default, the Windows installer will set the Stack root to C:\sr . Warning The Windows installer for Stack 2.9.1, 2.9.3 and 2.11.1 (only) will replace the user PATH environment variable (rather than append to it) if a 1024 character limit is exceeded. If the content of your existing user PATH is long, preserve it before running the installer. Note Systems with antivirus software may need to add Stack to the list of ’trusted’ applications. For other operating systems and direct downloads (rather than use GHCup), see the install and upgrade guide . How to upgrade Stack ¶ If Stack is already installed, you can upgrade it to the latest version by the command: stack upgrade Note If you used GHCup to install Stack, you should also use GHCup, and not Stack, to upgrade Stack. Quick Start guide ¶ For an immediate experience of using Stack to build an executable with Haskell, first you need to follow the guide to install Stack . Step 1: Start your new project ¶ To start a new project named my-project , issue these four commands in a terminal: stack new my-project cd my-project stack build stack exec my-project-exe The stack new my-project command will create a new directory, named my-project . It contains all the files needed to start a project correctly, using a default template. The cd my-project command will change the current working directory to that directory. The stack build command will build the template project and create an executable named my-project-exe (on Windows, my-project-exe.exe ). First, if necessary, Stack will download a version of GHC in an isolated location. That won’t interfere with other GHC installations on your system. The stack exec my-project-exe command will run (execute) the built executable, in Stack’s environment. For a complete list of Stack’s commands, and flags and options common to those commands, simply command: stack For help on a particular Stack command, including flags and options specific to that command, for example stack build , command: stack build help If you want to launch a run-eval-print loop (REPL) environment, then command: stack repl Info stack ghci can be used instead of stack repl . GHCi is GHC’s REPL tool. People organise Haskell code into packages. If you want to use Stack to install an executable provided by a Haskell package, then all you have to do is command: stack install package-name Step 2: Next steps ¶ The stack new my-project command in step one should have created the following files and directories (among others): . ├── app │ └── Main.hs ├── src │ └── Lib.hs ├── test │ └── Spec.hs ├── my-project.cabal ├── package.yaml └── stack.yaml The Haskell...