Meta tags:
description= A program for developing Haskell projects.
;
author= Stack contributors;
Headings (most frequently used words):
stack, to, start, guide, step, welcome, how, install, quick, complete, why, questions, get, involved, your, new, project, next, steps,
Text of the page (most frequently used words):
stack (102), the (98), and (44), #project (40), for (34), haskell (29), package (25), you (25), ghc (22), install (20), your (20), that (19), get (18), more (17), will (16), windows (16), code (15), file (15), guide (14), using (14), can (14), version (13), command (13), with (12), cabal (12), have (12), commands (12), script (12), configuration (11), new (11), directory (11), root (11), how (10), build (10), executable (10), haskellstack (10), org (10), source (9), use (9), start (9), files (9), access (9), also (8), used (8), add (8), provided (7), its (7), involved (7), see (7), learn (7), packages (7), work (7), specific (7), need (7), other (7), which (7), step (7), run (7), operating (7), uninstall (7), path (7), setting (7), tool (6), building (6), follow (6), about (6), want (6), questions (6), needs (6), has (6), complete (6), from (6), system (6), download (6), ghcup (6), installation (6), https (6), mac (6), welcome (6), library (5), not (5), projects (5), one (5), most (5), further (5), local (5), yaml (5), test (5), repl (5), environment (5), location (5), these (5), installed (5), systems (5), space (5), computers (5), apple (5), name (4), may (4), are (4), than (4), topics (4), getting (4), started (4), develops (4), dependencies (4), directly (4), contents (4), including (4), flags (4), options (4), default (4), program (4), programs (4), configure (4), easiest (4), way (4), silicon (4), intel (4), 2015 (3), contributors (3), was (3), under (3), faq (3), users (3), all (3), help (3), compiler (3), built (3), set (3), why (3), glossary (3), then (3), snapshot (3), delete (3), directories (3), each (3), next (3), steps (3), ghci (3), list (3), msys2 (3), provides (3), popular (3), tools (3), named (3), exe (3), quick (3), before (3), global (3), installing (3), architecture (3), arm (3), non (3), x86_64 (3), ask (3), such (3), order (3), platform (3), manager (3), prefer (3), control (3), manual (3), instructions (3), usr (3), bin (3), sudo (3), wget (3), curl (3), ssl (3), either (3), based (3), linux (3), macos (3), interactively (3), integration (3), this (2), them (2), first (2), known (2), simply (2), advice (2), please (2), frequently (2), asked (2), team (2), commercial (2), open (2), hackage (2), chosen (2), well (2), together (2), applications (2), specification (2), installations (2), automatically (2), glasgow (2), does (2), provide (2), experienced (2), developers (2), available (2), common (2), documentation (2), description (2), likely (2), section (2), specifies (2), update (2), describing (2), format (2), generates (2), suite (2), src (2), app (2), should (2), click (2), eval (2), example (2), necessary (2), template (2), create (2), needed (2), exec (2), terminal (2), once (2), unix (2), like (2), containing (2), different (2), config (2), information (2), upgrade (2), machine (2), hls (2), extensions (2), editors (2), language (2), direct (2), downloads (2), runs (2), username (2), software (2), installer (2), processors (2), aarch64 (2), include (2), developing (2), table (2), works (2), upgrading (2), maintainers (2), docker (2), github (2), made, material, mkdocs, copyright, 2025, back, top, distinguishes, between, public, commit, april, changed, now, widely, feedback, discussion, know, contribute, maintenance, development, general, post, forum, community, answers, volunteers, companies, auspices, group, originally, spearheaded, answer, since, become, thriving, meeting, types, sets, stackage, repository, providing, thousands, libraries, done, defining, performing, builds, premier, manage, select, appropriate, stand, alone, great, strong, focus, plans, reproducible, consistent, easy, aims, ability, customise, power, covering, ways, terms, explained, really, fast, introduction, recommend, read, dependency, reports, specified, recommended, action, extra, deps, level, turn, versions, identifies, depend, another, hpack, deleted, depends, uses, application, main, lib, spec, created, following, among, others, people, organise, into, instead, launch, print, loop, particular, those, execute, isolated, interfere, change, current, working, contains, correctly, complex, however, single, issue, four, immediate, experience, any, where, usually, located, outside, sufficient, remove, configures, takes, over, obtaining, some, combinations, elsewhere, separate, related, server, yet, solution, option, later, bug, means, they, character, value, variable, includes, antivirus, trusted, note, info, bit, machines, recently, microsoft, series, chip, chips, arm64, late, 2020, began, transition, distributions, architectures, various, require, least, disk, line, come, edit, there, number, freely, benchmarking, testing, features, compiled, programming, established, aimed, seeks, support, fully, history, resources, overview, signing, key, self, hosted, runners, zip, maintainer, process, releases, scheme, dev, containers, contributor, lock, azure, travis, shell, auto, completion, visual, studio, editor, debugging, standard, initialization, nix, interpreter, customisation, scripts, directive, variables, upload, unpack, templates, setup, sdist, runhaskell, runghc, query, purge, init, ide, hpc, hoogle, haddock, dot, clean, bench, conclusion, executing, locations, multi, targets, synonyms, databases, existing, hello, world, initializing, search, skip, content,
Text of the page (random words):
stack skip to content stack welcome initializing search github welcome setting up getting started commands configure topics get involved faq glossary more stack github welcome welcome table of contents how to install stack quick start guide step 1 start your new project step 2 next steps complete guide to stack why stack questions get involved setting up getting started getting started 1 a hello world example 2 package description 3 project configuration 4 building your project 5 building existing projects 6 installed package databases 7 stack build synonyms 8 stack build targets 9 multi package projects 10 cabal flags and ghc options 11 locations used by stack 12 executing commands 13 using ghc interactively 14 stack configuration 15 in conclusion commands commands bench build clean config dot docker eval exec ghc ghci haddock hoogle hpc ide init install list ls new path purge query repl run runghc runhaskell script sdist setup templates test uninstall unpack update upgrade upload configure configure environment variables configuration files configuration files project specific configuration non project specific configuration the include directive global flags and options customisation scripts topics topics stack root stack work directories stack environment snapshot location package location snapshot specification stack yaml vs a cabal file script interpreter docker integration nix integration non standard project initialization building ghc from source debugging editor integration stack and visual studio code developing on windows shell auto completion ci travis ci azure ci lock files haskell and c code get involved get involved contributors contributors contributor s guide dev containers maintainers maintainers version scheme releases maintainer team process add ghc version upgrading msys2 upgrading 7 zip haskellstack org self hosted runners signing key how stack works how stack works build overview faq glossary more more other resources version history table of contents how to install stack quick start guide step 1 start your new project step 2 next steps complete guide to stack why stack questions get involved welcome to stack welcome to the haskell programming language and stack stack is an established program for developing haskell projects 1 it is aimed at new and experienced users of haskell and seeks to support them fully on linux macos and windows haskell code is compiled by the glasgow haskell compiler ghc which can also be used interactively stack features include installing ghc automatically installing packages needed for your project building your project testing your project benchmarking your project using ghc interactively stack is used at the command line you will need terminal software for your system which will likely come with its operating system and a program to edit code files there are a number of freely available and popular code editors that have haskell extensions 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 stack can be installed directly or by using the ghcup tool directly ghcup stack can be installed directly on various operating systems linux macos windows other direct downloads for most linux distributions on x86_64 or aarch64 machine architectures the easiest way to install stack is to command either curl ssl https get haskellstack org sh or wget qo https get haskellstack org sh these commands download a script file and run it using sh will the installation script need root access 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 guide to setting up 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 is to command either curl ssl https get haskellstack org sh or wget qo https get haskellstack org sh these commands download a script file and run it using sh will the installation script need root access 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 guide to setting up mac computers with apple silicon have an m series chip these chips use an architecture known as arm64 or aarch64 for mac computers with apple silicon the easiest way to install stack is to command either curl ssl https get haskellstack org sh or wget qo https get haskellstack org sh these commands download a script file and run it using sh will the installation script need root access 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 guide to setting up most machines using the windows operating system have a x86_64 architecture more recently microsoft has provided windows on arm that runs on other processors x86_64 windows on arm on 64 bit windows the easiest way to install stack is to download and install the windows installer info by default the windows installer will set the stack root to c sr note systems with antivirus software may need to add stack to the list of trusted applications i have a windows username with a space in it ghc 9 4 1 and later have a bug which means they do not work if the path to the ghc executable has a space character in it the default location for stack s programs directory will have a space in the path if the value of the username environment variable includes a space a solution is to configure stack to use a different location for its programs directory for further information see the local programs path non project specific configuration option documentation the ghc project does not yet provide a version of ghc that runs on windows on arm for other operating systems and direct downloads see the guide to setting up the separate ghcup project provides a tool that can be used to install stack and other haskell related tools including ghc and haskell language server hls hls is a program that is used by haskell extensions for popular code editors 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 how do i upgrade stack follow the advice under setting up how do i remove stack for information about how to uninstall stack command stack uninstall to uninstall stack it should be sufficient to delete the stack root directory see stack path stack root before you uninstall if different the directory containing stack s global configuration file see stack path global config before you uninstall on windows the directory containing stack s tools see stack path programs before you uninstall which is usually located outside of the stack root directory and the stack executable file see which stack on unix like operating systems or where exe stack on windows you may also want to delete stack work directories in any haskell projects that you have built using stack quick start guide once stack is installed you can get an immediate experience of using it to build an executable with haskell step 1 start your new project a complex project can have more than one package and each package can have more than one executable program however to start a new single package project named my project issue these four commands in a terminal click to learn more about each command stack new my project 1 cd my project 2 stack build 3 stack exec my project exe 4 create a new directory named my project it contains all the files needed to start a project correctly using a default template change the current working directory to my project build the template project and create an executable named my project exe first if necessary stack will download a version of ghc in an isolated location that will not interfere with other ghc installations on your system on windows if necessary stack will also download msys2 msys2 is a project that provides popular tools for developers on windows 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 1 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 click to learn more about each file app main hs 1 src lib hs 2 test spec hs 3 my project cabal 4 package yaml 5 stack yaml 6 the haskell source code for the executable application as your project develops you can add further source code files to the app directory the executable uses a library the haskell source code for the library as your project develops you can add further source code files to the src directory the package has a test suite executable the haskell source code for the test suite as your project develops you can add further source code files to the test directory a file describing the package in the cabal format including other packages on which depends stack generates it from the contents of the package yaml file if the package yaml file is deleted stack will use the cabal file a file describing the package in the hpack format stack generates the my project cabal file from its contents if you want you can delete the file and update the cabal file directly as your project develops you may need to depend on a library provided by another haskell package if you do add the name of that new package to the dependencies section stack s project level configuration this specifies a snapshot that in turn specifies a version of ghc and a set of package versions chosen to work well together it also identifies the local packages in the project if you add a new package as a dependency in the package description and stack reports that the stack configuration has no specified version for it then follow stack s likely recommended action to add a specific version to the extra deps section that was a really fast introduction on how to start to code in haskell using stack if you want to go further we recommend you read stack s guide to getting started complete guide to stack a complete guide to stack is available covering the most common ways to use stack its commands its configuration specific topics and frequently asked questions terms used in stack s documentation are also explained in the glossary why stack stack has a strong focus on plans for building that are reproducible projects that have more than one package and a consistent easy to learn set of stack commands it also aims to provide the ability to customise and power that experienced developers need stack does not stand alone it is built on the great work provided by glasgow haskell compiler the premier haskell compiler stack will manage your ghc installations and automatically select the appropriate version of ghc for your project learn more cabal build system a specification for defining haskell packages and a library for performing builds 2 learn more hackage a repository of haskell packages providing thousands of open source libraries and applications to help you get your work done learn more stackage sets of packages from hackage that are chosen to work well together and with a specific version of ghc learn more stack is provided by a team of volunteers and companies under the auspices of the commercial haskell group the project was originally spearheaded by fp complete to answer the needs of commercial haskell users it has since become a thriving open source project meeting the needs of haskell users of all types questions for answers to frequently asked questions about stack please see the faq for general questions please post to the haskell community forum get involved follow the advice under get involved for feedback and discussion about stack or if you want to know how to contribute to its maintenance or development the project s first public commit was on 29 april 2015 it changed its name to the haskell tool stack on 18 may 2015 it is now widely known simply as stack cabal is also the name of a tool used for building haskell code provided by the cabal install package this guide distinguishes between them by cabal the library and cabal the tool back to top copyright c 2015 2025 stack contributors made with material for mkdocs
|
