Commands:¶

[global]

update

Updates list of known packages.

install

Install packages.

help

Help about commands.

info

Display detailed information about a particular package.

list

List packages matching a search string.

fetch

Downloads packages for later installation.

user-config

Display and update the user's global cabal configuration.

[package]

get

Download/Extract a package's source code (repository).

init

Create a new .cabal package file.

configure

Add extra project configuration

build

Compile targets within the project.

clean

Clean the package store and remove temporary files.

run

Run an executable.

repl

Open an interactive session for the given component.

test

Run test-suites

bench

Run benchmarks

check

Check the package for common mistakes.

sdist

Generate a source distribution file (.tar.gz).

upload

Uploads source packages or documentation to Hackage.

report

Upload build reports to a remote server.

freeze

Freeze dependencies.

gen-bounds

Generate dependency bounds.

outdated

Check for outdated dependencies

haddock

Build Haddock documentation

hscolour

Generate HsColour colourised code, in HTML format.

exec

Give a command access to the store.

list-bin

list path to a single executable.

[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 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-exec

Give a command access to the sandbox package repository.

v1-update

Updates list of known packages.

v1-install

Install packages.

v1-clean

Clean up after a build.

v1-doctest

Run doctest tests.

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

To install Cabal packages from hackage use:¶

cabal install foo [--dry-run]

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

cabal update

Global flags:¶

-h --help

Show this help text

-V --version

Print version information

--numeric-version

Print just the version number

--config-file=FILE

Set an alternate location for the config file

--default-user-config=FILE

Set a location for a cabal.config file for projects without their own cabal.config freeze file.

--ignore-expiry

Ignore expiry dates on signed metadata (use only in exceptional circumstances)

--http-transport=HttpTransport Set a transport for http(s) requests.

Accepts 'curl', 'wget', 'powershell', and 'plain-http'. (default: 'curl')

--enable-nix

Enable Nix integration: run commands through nix-shell if a 'shell.nix' file exists

--disable-nix

Disable Nix integration: run commands through nix-shell if a 'shell.nix' file exists

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

/homedoesnotexistatbuildtime/.cabal/config

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

compiled using version 3.4.1.0 of the Cabal library