CABAL-INSTALL(1)

📦
version 3.12.1.0 · 9 versions
, in ubuntu resolute, ubuntu stonking

💖 CABAL-INSTALL(1) 💖

okay bestie, sit down, hydrate, because this is the manual page for cabal-install version 3.12.1.0 and it's literally the front door to the whole Haskell Cabal situation. no cap.

✨ NAME ✨

cabal-install — the manual page for cabal-install version 3.12.1.0. that's the whole name section, we move.

🌸 SYNOPSIS 🌸

cabal [GLOBAL FLAGS] [COMMAND [FLAGS]]

that's it. that's the shape of every single thing you're about to do. flags, command, more flags. iconic.

🦋 DESCRIPTION 🦋

It's the command line interface to the Haskell Cabal infrastructure. the whole thing. your girl.

If you want more info (and honestly, who doesn't), it's at http://www.haskell.org/cabal/.

👑 Commands:

[global]

  • user-config — show and update your user's global cabal configuration. it's giving settings app but make it terminal.
  • help — help about commands. the classic. when in doubt, ask for help, no shame.

[package database]

  • update — updates the list of known packages. your package knowledge stays fresh, as it should.
  • list — list packages matching a search string. window shopping, but for packages.
  • info — display detailed information about a particular package. the deep dive, the lore, the backstory.

[initialization and download]

  • init — create a new cabal package. baby's first package, so cute.
  • fetch — downloads packages for later installation. saving them for later like a good little bookmark.
  • get — download/extract a package's source code (repository). yes the parenthetical is doing a lot of work there, i don't make the rules.

[project configuration]

  • configure — add extra project configuration.
  • freeze — freeze dependencies. lock them in place. periodt.
  • gen-bounds — generate dependency bounds. bounds are your friends, fr fr.
  • outdated — check for outdated dependencies. the vibe check your deps did NOT want.
  • path — query for simple project information. no period on that one, that's how the original rolls, i'm respecting it.

[project building and installing]

  • build — compile targets within the project. the main character command, honestly.
  • install — install packages.
  • haddock — build Haddock documentation.
  • haddock-project — generate Haddocks HTML documentation for the cabal project. yes, HTML, for the people who like pretty things (me).
  • clean — clean the package store and remove temporary files. spring cleaning energy, we love her.

[running and testing]

  • list-bin — list the path to a single executable. just the path. just the one. lowkey helpful.
  • repl — open an interactive session for the given component. poke at your code live, it's giving science experiment 🧪
  • run — run an executable.
  • bench — run benchmarks. numbers go brrr.
  • test — run test-suites. the moment of truth, hold my hand 🫶
  • exec — give a command access to the store.

[sanity checks and shipping]

  • check — check the package for common mistakes. your friend who reads your essay before you submit it.
  • sdist — generate a source distribution file (.tar.gz).
  • upload — uploads source packages or documentation to Hackage. going public, bestie!
  • report — upload build reports to a remote server.

[deprecated]

⚠️ heads up: these are deprecated, meaning don't start anything new with them. they're still listed, so here they are, faithfully.
  • unpack — deprecated alias for get.
  • hscolour — generate HsColour colourised code, in HTML format. yes, "colourised" with a u, that's the spelling, i'm not touching it.

[new-style projects (forwards-compatible aliases)]

  • v2-build — compile targets within the project.
  • v2-configure — add extra project configuration.
  • v2-repl — open an interactive session for the given component.
  • v2-run — run an executable.
  • v2-test — run test-suites.
  • v2-bench — run benchmarks.
  • v2-freeze — freeze dependencies.
  • v2-haddock — build Haddock documentation.
  • v2-exec — give a command access to the store.
  • v2-update — updates the list of known packages.
  • v2-install — install packages.
  • v2-clean — clean the package store and remove temporary files.
  • v2-sdist — generate a source distribution file (.tar.gz).

[legacy command aliases]

  • v1-build — compile all/specific components.
  • v1-configure — prepare to build the package.
  • v1-repl — open an interpreter session for the given component.
  • v1-run — builds and runs an executable.
  • v1-test — run all/specific tests in the test suite.
  • v1-bench — run all/specific benchmarks.
  • v1-freeze — freeze dependencies.
  • v1-haddock — generate Haddock HTML documentation.
  • v1-install — install packages.
  • v1-clean — clean up after a build.
  • v1-copy — copy the files of all/specific components to install locations.
  • v1-register — register this package with the compiler.
  • v1-reconfigure — reconfigure the package if necessary.

🎀 For more information about a command use:

cabal COMMAND --help

or

cabal help COMMAND

two paths, same destination. pick your fighter 💅

🍓 To install Cabal packages from hackage use:

cabal install foo [--dry-run]

the [--dry-run] is in brackets because it's optional, bestie, but honestly? try it first. look before you leap.

🌈 Occasionally you need to update the list of available packages:

cabal update

do it. don't skip it. your future self says thank you.

💜 Global flags:

  • -h, --help — show this help text.
  • -V, --version — print version information.
  • --numeric-version — print just the version number. just the number. no vibes, no frills.
  • --config-file=FILE — set an alternate location for the config file.
  • --ignore-expiry — ignore expiry dates on signed metadata. and listen: use only in exceptional circumstances. i'm serious, this one comes with a warning attached in the original and i am passing it straight to you.
  • --http-transport=HttpTransport — set a transport for http(s) requests. accepts 'curl', 'wget', 'powershell', and 'plain-http'. (default: 'curl')
  • --nix[=(True or False)] — [DEPRECATED] nix integration: run commands through nix-shell if a 'shell.nix' file exists (default is False).
  • --enable-nix — [DEPRECATED] enable Nix integration: run commands through nix-shell if a 'shell.nix' file exists.
  • --disable-nix — [DEPRECATED] disable Nix integration.
  • --store-dir=DIR — the location of the build store.
  • --active-repositories=REPOS — the active package repositories (set to ':none' to disable all repositories).
note that those three nix flags are all marked [DEPRECATED] in the original and i'm keeping that energy loud and clear. deprecated means deprecated. 🙈

🧚 You can edit the cabal configuration file to set defaults:

/sbuild-nonexistent/.config/cabal/config

that exact path, character for character, don't come for me.

This file will be generated with sensible defaults if you run 'cabal update'.

compiled using version 3.12.1.0 of the Cabal library.

and that's the whole page, bestie!! you read all of it, i'm so proud, genuinely 🥹 this was cabal-install version 3.12.1.0, from February 2026, and it's page CABAL-INSTALL(1) of the User Commands manual. go forth and cabal build, you absolute icon. 💖✨

📦 where this page comes from