Command Reference

This is a reference for all commands in the Spack command line interface. The same information is available through spack help.

Commands that also have sections in the main documentation have a link to “More documentation”.

Category Commands
Administration
Query packages
Build packages
Configuration
Container
Developer
Environments
Extensions
More help
Create packages
System
User environment

spack

A flexible package manager that supports multiple versions, configurations, platforms, and compilers.

spack [-hHdklLmpvV] [--color {always,never,auto}] [-C DIR] [--timestamp] [--pdb] [-e ENV | -D DIR | -E]
  [--use-env-repo] [--sorted-profile STAT] [--lines LINES] [--stacktrace] [--print-shell-vars PRINT_SHELL_VARS]
  COMMAND ...

Optional arguments

-h, --help
show this help message and exit
-H, --all-help
show help for all commands (same as spack help –all)
--color {always,never,auto}
when to colorize output (default: auto)
-C DIR, --config-scope DIR
add a custom configuration scope
-d, --debug
write out debug messages (more d’s for more verbosity: -d, -dd, -ddd, etc.)
--timestamp
Add a timestamp to tty output
--pdb
run spack under the pdb debugger
-e ENV, --env ENV
run with a specific environment (see spack env)
-D DIR, --env-dir DIR
run with an environment directory (ignore named environments)
-E, --no-env
run without any environments activated (see spack env)
--use-env-repo
when running in an environment, use its package repository
-k, --insecure
do not check ssl certificates when downloading
-l, --enable-locks
use filesystem locking (default)
-L, --disable-locks
do not use filesystem locking (unsafe)
-m, --mock
use mock packages instead of real ones
-p, --profile
profile execution using cProfile
--sorted-profile STAT
profile and sort by one or more of: [calls, ncalls, cumtime, cumulative, filename, line, module]
--lines LINES
lines of profile output or ‘all’ (default: 20)
-v, --verbose
print additional output during builds
--stacktrace
add stacktraces to all printed statements
-V, --version
show version number and exit
--print-shell-vars PRINT_SHELL_VARS
print info needed by setup-env.[c]sh

Subcommands


spack activate

activate a package extension

spack activate [-hf] [-v VIEW] ...

More documentation

Positional arguments

installed_spec
installed package spec

Optional arguments

-h, --help
show this help message and exit
-f, --force
activate without first activating dependencies
-v VIEW, --view VIEW
the view to operate on

spack add

add a spec to an environment

spack add [-h] [-l LIST_NAME] ...

Positional arguments

specs
one or more package specs

Optional arguments

-h, --help
show this help message and exit
-l LIST_NAME, --list-name LIST_NAME
name of the list to add specs to

spack arch

print architecture information about this machine

spack arch [-h] [--known-targets] [-p | -o | -t] [-f | -b]

Optional arguments

-h, --help
show this help message and exit
--known-targets
show a list of all known targets and exit
-p, --platform
print only the platform
-o, --operating-system
print only the operating system
-t, --target
print only the target
-f, --frontend
print frontend
-b, --backend
print backend

spack blame

show contributors to packages

spack blame [-h] [-t | -p | -g] package_or_file

Positional arguments

package_or_file
name of package to show contributions for, or path to a file in the spack repo

Optional arguments

-h, --help
show this help message and exit
-t, --time
sort by last modification date (default)
-p, --percent
sort by percent of code
-g, --git
show git blame output instead of summary

spack build-env

run a command in a spec’s install environment, or dump its environment to screen or file

spack build-env [-h] [--clean] [--dirty] [--dump FILE] [--pickle FILE] ...

More documentation

Positional arguments

spec [–] [cmd]…
spec of package environment to emulate

Optional arguments

-h, --help
show this help message and exit
--clean
unset harmful variables in the build environment (default)
--dirty
preserve user environment in spack’s build environment (danger!)
--dump FILE
dump a source-able environment to FILE
--pickle FILE
dump a pickled source-able environment to FILE

spack buildcache

create, download and install binary packages

spack buildcache [-h] SUBCOMMAND ...

More documentation

Optional arguments

-h, --help
show this help message and exit

Subcommands


spack buildcache create

spack buildcache create [-hrfua] [-k key] (-d directory | -m mirror-name | --mirror-url mirror-url) [--rebuild-index]
                    [-y SPEC_YAML] [--only {package,dependencies}]
                    ...

Positional arguments

specs
one or more package specs

Optional arguments

-h, --help
show this help message and exit
-r, --rel
make all rpaths relative before creating tarballs.
-f, --force
overwrite tarball if it exists.
-u, --unsigned
create unsigned buildcache tarballs for testing
-a, --allow-root
allow install root string in binary files after RPATH substitution
-k key, --key key
Key for signing.
-d directory, --directory directory
local directory where buildcaches will be written.
-m mirror-name, --mirror-name mirror-name
name of the mirror where buildcaches will be written.
--mirror-url mirror-url
URL of the mirror where buildcaches will be written.
--rebuild-index
Regenerate buildcache index after building package(s)
-y SPEC_YAML, --spec-yaml SPEC_YAML
Create buildcache entry for spec from yaml file
--only {package,dependencies}
Select the buildcache mode. the default is to build a cache for the package along with all its dependencies. Alternatively, one can decide to build a cache for only the package or only the dependencies

spack buildcache install

spack buildcache install [-hfmauo] ...

Positional arguments

specs
one or more package specs

Optional arguments

-h, --help
show this help message and exit
-f, --force
overwrite install directory if it exists.
-m, --multiple
allow all matching packages
-a, --allow-root
allow install root string in binary files after RPATH substitution
-u, --unsigned
install unsigned buildcache tarballs for testing
-o, --otherarch
install specs from other architectures instead of default platform and OS

spack buildcache list

spack buildcache list [-hlLva] ...

Positional arguments

specs
one or more package specs

Optional arguments

-h, --help
show this help message and exit
-l, --long
show dependency hashes as well as versions
-L, --very-long
show full dependency hashes as well as versions
-v, --variants
show variants in output (can be long)
-a, --allarch
list specs for all available architectures instead of default platform and OS

spack buildcache keys

spack buildcache keys [-hitf]

Optional arguments

-h, --help
show this help message and exit
-i, --install
install Keys pulled from mirror
-t, --trust
trust all downloaded keys
-f, --force
force new download of keys

spack buildcache preview

spack buildcache preview [-h] ...

Positional arguments

installed_specs
one or more installed package specs

Optional arguments

-h, --help
show this help message and exit

spack buildcache check

spack buildcache check [-h] [-m MIRROR_URL] [-o OUTPUT_FILE] [--scope {defaults,system,site,user}[/PLATFORM]]
                   [-s SPEC] [-y SPEC_YAML] [--rebuild-on-error]

Optional arguments

-h, --help
show this help message and exit
-m MIRROR_URL, --mirror-url MIRROR_URL
Override any configured mirrors with this mirror url
-o OUTPUT_FILE, --output-file OUTPUT_FILE
File where rebuild info should be written
--scope {defaults,system,site,user}[/PLATFORM]
configuration scope containing mirrors to check
-s SPEC, --spec SPEC
Check single spec instead of release specs file
-y SPEC_YAML, --spec-yaml SPEC_YAML
Check single spec from yaml file instead of release specs file
--rebuild-on-error
Default to rebuilding packages if errors are encountered during the process of checking whether rebuilding is needed

spack buildcache download

spack buildcache download [-hc] [-s SPEC] [-y SPEC_YAML] [-p PATH]

Optional arguments

-h, --help
show this help message and exit
-s SPEC, --spec SPEC
Download built tarball for spec from mirror
-y SPEC_YAML, --spec-yaml SPEC_YAML
Download built tarball for spec (from yaml file) from mirror
-p PATH, --path PATH
Path to directory where tarball should be downloaded
-c, --require-cdashid
Require .cdashid file to be downloaded with buildcache entry

spack buildcache get-buildcache-name

spack buildcache get-buildcache-name [-h] [-s SPEC] [-y SPEC_YAML]

Optional arguments

-h, --help
show this help message and exit
-s SPEC, --spec SPEC
Spec string for which buildcache name is desired
-y SPEC_YAML, --spec-yaml SPEC_YAML
Path to spec yaml file for which buildcache name is desired

spack buildcache save-yaml

spack buildcache save-yaml [-h] [--root-spec ROOT_SPEC] [--root-spec-yaml ROOT_SPEC_YAML] [-s SPECS] [-y YAML_DIR]

Optional arguments

-h, --help
show this help message and exit
--root-spec ROOT_SPEC
Root spec of dependent spec
--root-spec-yaml ROOT_SPEC_YAML
Path to yaml file containing root spec of dependent spec
-s SPECS, --specs SPECS
List of dependent specs for which saved yaml is desired
-y YAML_DIR, --yaml-dir YAML_DIR
Path to directory where spec yamls should be saved

spack buildcache copy

spack buildcache copy [-h] [--base-dir BASE_DIR] [--spec-yaml SPEC_YAML] [--destination-url DESTINATION_URL]

Optional arguments

-h, --help
show this help message and exit
--base-dir BASE_DIR
Path to mirror directory (root of existing buildcache)
--spec-yaml SPEC_YAML
Path to spec yaml file representing buildcache entry to copy
--destination-url DESTINATION_URL
Destination mirror url

spack buildcache update-index

spack buildcache update-index [-hk] [-d MIRROR_URL]

Optional arguments

-h, --help
show this help message and exit
-d MIRROR_URL, --mirror-url MIRROR_URL
Destination mirror url
-k, --keys
If provided, key index will be updated as well as package index

spack cd

cd to spack directories in the shell

spack cd [-h] [-m | -r | -i | -p | -P | -s | -S | -b | -e ENV] ...

More documentation

Positional arguments

spec
package spec

Optional arguments

-h, --help
show this help message and exit
-m, --module-dir
spack python module directory
-r, --spack-root
spack installation root
-i, --install-dir
install prefix for spec (spec need not be installed)
-p, --package-dir
directory enclosing a spec’s package.py file
-P, --packages
top-level packages directory for Spack
-s, --stage-dir
stage directory for a spec
-S, --stages
top level stage directory
-b, --build-dir
checked out or expanded source directory for a spec (requires it to be staged first)
-e ENV, --env ENV
location of an environment managed by spack

spack checksum

checksum available versions of a package

spack checksum [-hb] [--keep-stage] package ...

More documentation

Positional arguments

package
package name
versions
versions to generate checksums for

Optional arguments

-h, --help
show this help message and exit
--keep-stage
don’t clean up staging area when command completes
-b, --batch
don’t ask which versions to checksum

spack ci

manage continuous integration pipelines

spack ci [-h] SUBCOMMAND ...

More documentation

Optional arguments

-h, --help
show this help message and exit

Subcommands


spack ci generate

spack ci generate [-h] [--output-file OUTPUT_FILE] [--copy-to COPY_TO] [--optimize] [--dependencies]

More documentation

Optional arguments

-h, --help
show this help message and exit
--output-file OUTPUT_FILE
Path to file where generated jobs file should be written. The default is .gitlab-ci.yml in the root of the repository.
--copy-to COPY_TO
Absolute path of additional location where generated jobs yaml file should be copied. Default is not to copy.
--optimize
(Experimental) run the generated document through a series of optimization passes designed to reduce the size of the generated file.
--dependencies
(Experimental) disable DAG scheduling; use “plain” dependencies.

spack ci rebuild

spack ci rebuild [-h]

More documentation

Optional arguments

-h, --help
show this help message and exit

spack clean

remove temporary build files and/or downloaded archives

spack clean [-hsdfmpa] ...

More documentation

Positional arguments

specs
one or more package specs

Optional arguments

-h, --help
show this help message and exit
-s, --stage
remove all temporary build stages (default)
-d, --downloads
remove cached downloads
-f, --failures
force removal of all install failure tracking markers
-m, --misc-cache
remove long-lived caches, like the virtual package index
-p, --python-cache
remove .pyc, .pyo files and __pycache__ folders
-a, --all
equivalent to -sdfmp

spack clone

create a new installation of spack in another prefix

spack clone [-h] [-r REMOTE] prefix

Positional arguments

prefix
name of prefix where we should install spack

Optional arguments

-h, --help
show this help message and exit
-r REMOTE, --remote REMOTE
name of the remote to clone from

spack commands

list available spack commands

spack commands [-ha] [--update-completion] [--format {subcommands,rst,names,bash}] [--header FILE] [--update FILE] ...

Positional arguments

rst_files
list of rst files to search for _cmd-spack-<cmd> cross-refs

Optional arguments

-h, --help
show this help message and exit
--update-completion
regenerate spack’s tab completion scripts
-a, --aliases
include command aliases
--format {subcommands,rst,names,bash}
format to be used to print the output (default: names)
--header FILE
prepend contents of FILE to the output (useful for rst format)
--update FILE
write output to the specified file, if any command is newer

spack compiler

manage compilers

spack compiler [-h] SUBCOMMAND ...

Optional arguments

-h, --help
show this help message and exit

Subcommands


spack compiler find

spack compiler find [-h] [--scope {defaults,system,site,user}[/PLATFORM]] ...

More documentation

Positional arguments

add_paths

Optional arguments

-h, --help
show this help message and exit
--scope {defaults,system,site,user}[/PLATFORM]
configuration scope to modify

spack compiler remove

spack compiler remove [-ha] [--scope {defaults,system,site,user}[/PLATFORM]] compiler_spec

Positional arguments

compiler_spec

Optional arguments

-h, --help
show this help message and exit
-a, --all
remove ALL compilers that match spec
--scope {defaults,system,site,user}[/PLATFORM]
configuration scope to modify

spack compiler list

spack compiler list [-h] [--scope {defaults,system,site,user}[/PLATFORM]]

Optional arguments

-h, --help
show this help message and exit
--scope {defaults,system,site,user}[/PLATFORM]
configuration scope to read from

spack compiler info

spack compiler info [-h] [--scope {defaults,system,site,user}[/PLATFORM]] compiler_spec

More documentation

Positional arguments

compiler_spec

Optional arguments

-h, --help
show this help message and exit
--scope {defaults,system,site,user}[/PLATFORM]
configuration scope to read from

spack compilers

list available compilers

spack compilers [-h] [--scope {defaults,system,site,user}[/PLATFORM]]

More documentation

Optional arguments

-h, --help
show this help message and exit
--scope {defaults,system,site,user}[/PLATFORM]
configuration scope to read/modify

spack concretize

concretize an environment and write a lockfile

spack concretize [-hf]

Optional arguments

-h, --help
show this help message and exit
-f, --force
Re-concretize even if already concretized.

spack config

get and set configuration options

spack config [-h] [--scope {defaults,system,site,user}[/PLATFORM]] SUBCOMMAND ...

Optional arguments

-h, --help
show this help message and exit
--scope {defaults,system,site,user}[/PLATFORM]
configuration scope to read/modify

Subcommands


spack config get

spack config get [-h] [section]

More documentation

Positional arguments

section
configuration section to print. options: compilers, mirrors, repos, packages, modules, config, upstreams

Optional arguments

-h, --help
show this help message and exit

spack config blame

spack config blame [-h] section

More documentation

Positional arguments

section
configuration section to print. options: compilers, mirrors, repos, packages, modules, config, upstreams

Optional arguments

-h, --help
show this help message and exit

spack config edit

spack config edit [-h] [--print-file] [section]

Positional arguments

section
configuration section to edit. options: compilers, mirrors, repos, packages, modules, config, upstreams

Optional arguments

-h, --help
show this help message and exit
--print-file
print the file name that would be edited

spack config list

spack config list [-h]

Optional arguments

-h, --help
show this help message and exit

spack config add

spack config add [-h] [-f FILE] [path]

Positional arguments

path
colon-separated path to config that should be added, e.g. ‘config:default:true’

Optional arguments

-h, --help
show this help message and exit
-f FILE, --file FILE
file from which to set all config values

spack config remove

spack config remove [-h] path

Positional arguments

path
colon-separated path to config that should be removed, e.g. ‘config:default:true’

Optional arguments

-h, --help
show this help message and exit

spack config update

spack config update [-hy] section

Positional arguments

section
section to update

Optional arguments

-h, --help
show this help message and exit
-y, --yes-to-all
assume “yes” is the answer to every confirmation request

spack config revert

spack config revert [-hy] section

Positional arguments

section
section to update

Optional arguments

-h, --help
show this help message and exit
-y, --yes-to-all
assume “yes” is the answer to every confirmation request

spack containerize

creates recipes to build images for different container runtimes

spack containerize [-h]

Optional arguments

-h, --help
show this help message and exit

spack create

create a new package file

spack create [-hfb] [--keep-stage] [-n NAME] [-t TEMPLATE] [-r REPO] [-N NAMESPACE] [--skip-editor] [url]

More documentation

Positional arguments

url
url of package archive

Optional arguments

-h, --help
show this help message and exit
--keep-stage
don’t clean up staging area when command completes
-n NAME, --name NAME
name of the package to create
-t TEMPLATE, --template TEMPLATE
build system template to use. options: autoreconf, autotools, bazel, bundle, cmake, generic, intel, makefile, maven, meson, octave, perlbuild, perlmake, python, qmake, r, ruby, scons, sip, waf
-r REPO, --repo REPO
path to a repository where the package should be created
-N NAMESPACE, --namespace NAMESPACE
specify a namespace for the package. must be the namespace of a repository registered with Spack
-f, --force
overwrite any existing package file with the same name
--skip-editor
skip the edit session for the package (e.g., automation)
-b, --batch
don’t ask which versions to checksum

spack deactivate

deactivate a package extension

spack deactivate [-hfa] [-v VIEW] ...

More documentation

Positional arguments

installed_spec
installed package spec

Optional arguments

-h, --help
show this help message and exit
-f, --force
run deactivation even if spec is NOT currently activated
-v VIEW, --view VIEW
the view to operate on
-a, --all
deactivate all extensions of an extendable package, or deactivate an extension AND its dependencies

spack debug

debugging commands for troubleshooting Spack

spack debug [-h] SUBCOMMAND ...

Optional arguments

-h, --help
show this help message and exit

Subcommands


spack debug create-db-tarball

spack debug create-db-tarball [-h]

Optional arguments

-h, --help
show this help message and exit

spack debug report

spack debug report [-h]

Optional arguments

-h, --help
show this help message and exit

spack dependencies

show dependencies of a package

spack dependencies [-hitV] [--deptype DEPTYPE] ...

Positional arguments

spec
package spec

Optional arguments

-h, --help
show this help message and exit
-i, --installed
List installed dependencies of an installed spec, instead of possible dependencies of a package.
-t, --transitive
show all transitive dependencies
--deptype DEPTYPE
comma-separated list of deptypes to traverse default=build,link,run,test
-V, --no-expand-virtuals
do not expand virtual dependencies

spack dependents

show packages that depend on another

spack dependents [-hit] ...

Positional arguments

spec
package spec

Optional arguments

-h, --help
show this help message and exit
-i, --installed
List installed dependents of an installed spec, instead of possible dependents of a package.
-t, --transitive
Show all transitive dependents.

spack deprecate

Replace one package with another via symlinks

spack deprecate [-hy] [-d | -D] [-i | -I] [-l {soft,hard}] ...

Positional arguments

specs
spec to deprecate and spec to use as deprecator

Optional arguments

-h, --help
show this help message and exit
-y, --yes-to-all
assume “yes” is the answer to every confirmation request
-d, --dependencies
Deprecate dependencies (default)
-D, --no-dependencies
Do not deprecate dependencies
-i, --install-deprecator
Concretize and install deprecator spec
-I, --no-install-deprecator
Deprecator spec must already be installed (default)
-l {soft,hard}, --link-type {soft,hard}
Type of filesystem link to use for deprecation (default soft)

spack dev-build

developer build: build from code in current working directory

spack dev-build [-hinq] [-j JOBS] [-d SOURCE_PATH] [--keep-prefix] [--skip-patch] [--drop-in SHELL]
            [--test {root,all}] [-b BEFORE | -u UNTIL] [--clean | --dirty]
            ...

Positional arguments

spec
package spec

Optional arguments

-h, --help
show this help message and exit
-j JOBS, --jobs JOBS
explicitly set number of parallel jobs
-d SOURCE_PATH, --source-path SOURCE_PATH
path to source directory. defaults to the current directory
-i, --ignore-dependencies
don’t try to install dependencies of requested packages
-n, --no-checksum
do not use checksums to verify downloaded files (unsafe)
--keep-prefix
do not remove the install prefix if installation fails
--skip-patch
skip patching for the developer build
-q, --quiet
do not display verbose build output while installing
--drop-in SHELL
drop into a build environment in a new shell, e.g. bash, zsh
--test {root,all}
If ‘root’ is chosen, run package tests during installation for top-level packages (but skip tests for dependencies). if ‘all’ is chosen, run package tests during installation for all packages. If neither are chosen, don’t run tests for any packages.
-b BEFORE, --before BEFORE
phase to stop before when installing (default None)
-u UNTIL, --until UNTIL
phase to stop after when installing (default None)
--clean
unset harmful variables in the build environment (default)
--dirty
preserve user environment in spack’s build environment (danger!)

spack develop

add a spec to an environment’s dev-build information

spack develop [-h] [-p PATH] [--no-clone | --clone] [-f FORCE] ...

Positional arguments

spec
package spec

Optional arguments

-h, --help
show this help message and exit
-p PATH, --path PATH
Source location of package
--no-clone
Do not clone. The package already exists at the source path
--clone
Clone the package even if the path already exists
-f FORCE, --force FORCE
Remove any files or directories that block cloning source code

spack docs

open spack documentation in a web browser

spack docs [-h]

Optional arguments

-h, --help
show this help message and exit

spack edit

open package files in $EDITOR

spack edit [-h] [-b | -c | -d | -t | -m | -r REPO | -N NAMESPACE] [package]

More documentation

Positional arguments

package
package name

Optional arguments

-h, --help
show this help message and exit
-b, --build-system
Edit the build system with the supplied name.
-c, --command
edit the command with the supplied name
-d, --docs
edit the docs with the supplied name
-t, --test
edit the test with the supplied name
-m, --module
edit the main spack module with the supplied name
-r REPO, --repo REPO
path to repo to edit package in
-N NAMESPACE, --namespace NAMESPACE
namespace of package to edit

spack env

manage virtual environments

spack env [-h] SUBCOMMAND ...

Optional arguments

-h, --help
show this help message and exit

Subcommands


spack env activate

spack env activate [-hdp] [--sh | --csh | --fish] [-v | -V] env

Positional arguments

env
name of environment to activate

Optional arguments

-h, --help
show this help message and exit
--sh
print sh commands to activate the environment
--csh
print csh commands to activate the environment
--fish
print fish commands to activate the environment
-v, --with-view
update PATH etc. with associated view
-V, --without-view
do not update PATH etc. with associated view
-d, --dir
force spack to treat env as a directory, not a name
-p, --prompt
decorate the command line prompt when activating

spack env deactivate

spack env deactivate [-h] [--sh | --csh | --fish]

Optional arguments

-h, --help
show this help message and exit
--sh
print sh commands to deactivate the environment
--csh
print csh commands to deactivate the environment
--fish
print fish commands to activate the environment

spack env create

spack env create [-hd] [--without-view | --with-view WITH_VIEW] env [envfile]

Positional arguments

env
name of environment to create
envfile
optional init file; can be spack.yaml or spack.lock

Optional arguments

-h, --help
show this help message and exit
-d, --dir
create an environment in a specific directory
--without-view
do not maintain a view for this environment
--with-view WITH_VIEW
specify that this environment should maintain a view at the specified path (by default the view is maintained in the environment directory)

spack env remove

spack env remove [-hy] env [env ...]

Positional arguments

env
environment(s) to remove

Optional arguments

-h, --help
show this help message and exit
-y, --yes-to-all
assume “yes” is the answer to every confirmation request

spack env list

spack env list [-h]

Optional arguments

-h, --help
show this help message and exit

spack env status

spack env status [-h]

Optional arguments

-h, --help
show this help message and exit

spack env loads

spack env loads [-hr] [-m {tcl,lmod}] [--input-only] [-p PREFIX] [-x EXCLUDE] [env]

Positional arguments

env
name of env to generate loads file for

Optional arguments

-h, --help
show this help message and exit
-m {tcl,lmod}, --module-type {tcl,lmod}
type of module system to generate loads for
--input-only
generate input for module command (instead of a shell script)
-p PREFIX, --prefix PREFIX
prepend to module names when issuing module load commands
-x EXCLUDE, --exclude EXCLUDE
exclude package from output; may be specified multiple times
-r, --dependencies
recursively traverse spec dependencies

spack env view

spack env view [-h] {regenerate,enable,disable} [view_path]

Positional arguments

{regenerate,enable,disable}
action to take for the environment’s view
view_path
when enabling a view, optionally set the path manually

Optional arguments

-h, --help
show this help message and exit

spack env update

spack env update [-hy] env

Positional arguments

env
name or directory of the environment to activate

Optional arguments

-h, --help
show this help message and exit
-y, --yes-to-all
assume “yes” is the answer to every confirmation request

spack env revert

spack env revert [-hy] env

Positional arguments

env
name or directory of the environment to activate

Optional arguments

-h, --help
show this help message and exit
-y, --yes-to-all
assume “yes” is the answer to every confirmation request

spack extensions

list extensions for package

spack extensions [-hlLdp] [-s {packages,installed,activated,all}] [-v VIEW] ...

More documentation

Positional arguments

extendable
spec of package to list extensions for

Optional arguments

-h, --help
show this help message and exit
-l, --long
show dependency hashes as well as versions
-L, --very-long
show full dependency hashes as well as versions
-d, --deps
output dependencies along with found specs
-p, --paths
show paths to package install directories
-s {packages,installed,activated,all}, --show {packages,installed,activated,all}
show only part of output
-v VIEW, --view VIEW
the view to operate on

spack external

manage external packages in Spack configuration

spack external [-h] SUBCOMMAND ...

Optional arguments

-h, --help
show this help message and exit

Subcommands


spack external find

spack external find [-h] [--not-buildable] [--scope {defaults,system,site,user}[/PLATFORM]] ...

More documentation

Positional arguments

packages

Optional arguments

-h, --help
show this help message and exit
--not-buildable
packages with detected externals won’t be built with Spack
--scope {defaults,system,site,user}[/PLATFORM]
configuration scope to modify

spack external list

spack external list [-h]

Optional arguments

-h, --help
show this help message and exit

spack fetch

fetch archives for packages

spack fetch [-hnmD] ...

More documentation

Positional arguments

specs
one or more package specs

Optional arguments

-h, --help
show this help message and exit
-n, --no-checksum
do not use checksums to verify downloaded files (unsafe)
-m, --missing
fetch only missing (not yet installed) dependencies
-D, --dependencies
also fetch all dependencies

spack find

list and search installed packages

spack find [-hdplLcfumvMN] [--format FORMAT | --json] [--groups] [--no-groups] [-t TAGS] [--show-full-compiler]
       [-x | -X] [--loaded] [--deprecated] [--only-deprecated] [--start-date START_DATE] [--end-date END_DATE]
       ...

More documentation

Positional arguments

installed_specs
constraint to select a subset of installed packages

Optional arguments

-h, --help
show this help message and exit
--format FORMAT
output specs with the specified format string
--json
output specs as machine-readable json records
-d, --deps
output dependencies along with found specs
-p, --paths
show paths to package install directories
--groups
display specs in arch/compiler groups (default on)
--no-groups
do not group specs by arch/compiler
-l, --long
show dependency hashes as well as versions
-L, --very-long
show full dependency hashes as well as versions
-t TAGS, --tags TAGS
filter a package query by tags
-c, --show-concretized
show concretized specs in an environment
-f, --show-flags
show spec compiler flags
--show-full-compiler
show full compiler specs
-x, --explicit
show only specs that were installed explicitly
-X, --implicit
show only specs that were installed as dependencies
-u, --unknown
show only specs Spack does not have a package for
-m, --missing
show missing dependencies as well as installed specs
-v, --variants
show variants in output (can be long)
--loaded
show only packages loaded in the user environment
-M, --only-missing
show only missing dependencies
--deprecated
show deprecated packages as well as installed specs
--only-deprecated
show only deprecated packages
-N, --namespace
show fully qualified package names
--start-date START_DATE
earliest date of installation [YYYY-MM-DD]
--end-date END_DATE
latest date of installation [YYYY-MM-DD]

spack flake8

runs source code style checks on Spack. requires flake8

spack flake8 [-hkaorU] [-b BASE] ...

Positional arguments

files
specific files to check

Optional arguments

-h, --help
show this help message and exit
-b BASE, --base BASE
select base branch for collecting list of modified files
-k, --keep-temp
do not delete temporary directory where flake8 runs. use for debugging, to see filtered files
-a, --all
check all files, not just changed files
-o, --output
send filtered files to stdout as well as temp files
-r, --root-relative
print root-relative paths (default: cwd-relative)
-U, --no-untracked
exclude untracked files from checks

spack gc

remove specs that are now no longer needed

spack gc [-hy]

Optional arguments

-h, --help
show this help message and exit
-y, --yes-to-all
assume “yes” is the answer to every confirmation request

spack gpg

handle GPG actions for spack

spack gpg [-h] SUBCOMMAND ...

More documentation

Optional arguments

-h, --help
show this help message and exit

Subcommands


spack gpg verify

spack gpg verify [-h] ... [signature]

Positional arguments

installed_spec
installed package spec
signature
the signature file

Optional arguments

-h, --help
show this help message and exit

spack gpg trust

spack gpg trust [-h] keyfile

Positional arguments

keyfile
add a key to the trust store

Optional arguments

-h, --help
show this help message and exit

spack gpg untrust

spack gpg untrust [-h] [--signing] keys [keys ...]

Positional arguments

keys
remove keys from the trust store

Optional arguments

-h, --help
show this help message and exit
--signing
allow untrusting signing keys

spack gpg sign

spack gpg sign [-h] [--output DEST] [--key KEY] [--clearsign] ...

Positional arguments

installed_spec
installed package spec

Optional arguments

-h, --help
show this help message and exit
--output DEST
the directory to place signatures
--key KEY
the key to use for signing
--clearsign
if specified, create a clearsign signature

spack gpg create

spack gpg create [-h] [--comment COMMENT] [--expires EXPIRATION] [--export DEST] name email

Positional arguments

name
the name to use for the new key
email
the email address to use for the new key

Optional arguments

-h, --help
show this help message and exit
--comment COMMENT
a description for the intended use of the key
--expires EXPIRATION
when the key should expire
--export DEST
export the public key to a file

spack gpg list

spack gpg list [-h] [--trusted] [--signing]

Optional arguments

-h, --help
show this help message and exit
--trusted
list trusted keys
--signing
list keys which may be used for signing

spack gpg init

spack gpg init [-h]

Optional arguments

-h, --help
show this help message and exit
--from DIR
==SUPPRESS==

spack gpg export

spack gpg export [-h] location [keys [keys ...]]

Positional arguments

location
where to export keys
keys
the keys to export; all secret keys if unspecified

Optional arguments

-h, --help
show this help message and exit

spack gpg publish

spack gpg publish [-h] (-d directory | -m mirror-name | --mirror-url mirror-url) [--rebuild-index] [keys [keys ...]]

Positional arguments

keys
the keys to publish; all public keys if unspecified

Optional arguments

-h, --help
show this help message and exit
-d directory, --directory directory
local directory where keys will be published.
-m mirror-name, --mirror-name mirror-name
name of the mirror where keys will be published.
--mirror-url mirror-url
URL of the mirror where keys will be published.
--rebuild-index
Regenerate buildcache key index after publishing key(s)

spack graph

generate graphs of package dependency relationships

spack graph [-hsi] [-a | -d] [--deptype DEPTYPE] ...

More documentation

Positional arguments

specs
one or more package specs

Optional arguments

-h, --help
show this help message and exit
-a, --ascii
draw graph as ascii to stdout (default)
-d, --dot
generate graph in dot format and print to stdout
-s, --static
graph static (possible) deps, don’t concretize (implies –dot)
-i, --installed
graph all installed specs in dot format (implies –dot)
--deptype DEPTYPE
comma-separated list of deptypes to traverse default=build,link,run,test

spack help

get help on spack and its commands

spack help [-ha] [--spec] help_command]

More documentation

Positional arguments

help_command
command to get help on

Optional arguments

-h, --help
show this help message and exit
-a, --all
list all available commands and options
--spec
help on the package specification syntax

spack info

get detailed information on a particular package

spack info [-h] package

More documentation

Positional arguments

package
package name

Optional arguments

-h, --help
show this help message and exit

spack install

build and install packages

spack install [-hnvy] [--only {package,dependencies}] [-u UNTIL] [-j JOBS] [--overwrite] [--fail-fast] [--keep-prefix]
          [--keep-stage] [--dont-restage] [--use-cache | --no-cache | --cache-only] [--no-check-signature]
          [--require-full-hash-match] [--show-log-on-error] [--source] [--fake] [--only-concrete]
          [-f SPEC_YAML_FILE] [--clean | --dirty] [--test {root,all} | --run-tests]
          [--log-format {None,junit,cdash}] [--log-file LOG_FILE] [--help-cdash]
          ...

More documentation

Positional arguments

spec
package spec

Optional arguments

-h, --help
show this help message and exit
--only {package,dependencies}
select the mode of installation. the default is to install the package along with all its dependencies. alternatively one can decide to install only the package or only the dependencies
-u UNTIL, --until UNTIL
phase to stop after when installing (default None)
-j JOBS, --jobs JOBS
explicitly set number of parallel jobs
--overwrite
reinstall an existing spec, even if it has dependents
--fail-fast
stop all builds if any build fails (default is best effort)
--keep-prefix
don’t remove the install prefix if installation fails
--keep-stage
don’t remove the build stage if installation succeeds
--dont-restage
if a partial install is detected, don’t delete prior state
--use-cache
check for pre-built Spack packages in mirrors (default)
--no-cache
do not check for pre-built Spack packages in mirrors
--cache-only
only install package from binary mirrors
--no-check-signature
do not check signatures of binary packages
--require-full-hash-match
when installing from binary mirrors, do not install binary package unless the full hash of the remote spec matches that of the local spec
--show-log-on-error
print full build log to stderr if build fails
--source
install source files in prefix
-n, --no-checksum
do not use checksums to verify downloaded files (unsafe)
-v, --verbose
display verbose build output while installing
--fake
fake install for debug purposes.
--only-concrete
(with environment) only install already concretized specs
-f SPEC_YAML_FILE, --file SPEC_YAML_FILE
install from file. Read specs to install from .yaml files
--clean
unset harmful variables in the build environment (default)
--dirty
preserve user environment in spack’s build environment (danger!)
--test {root,all}
If ‘root’ is chosen, run package tests during installation for top-level packages (but skip tests for dependencies). if ‘all’ is chosen, run package tests during installation for all packages. If neither are chosen, don’t run tests for any packages.
--run-tests
run package tests during installation (same as –test=all)
--log-format {None,junit,cdash}
format to be used for log files
--log-file LOG_FILE
filename for the log file. if not passed a default will be used
--help-cdash
Show usage instructions for CDash reporting
-y, --yes-to-all
assume “yes” is the answer to every confirmation request. To run completely non-interactively, also specify ‘–no-checksum’.
--cdash-upload-url CDASH_UPLOAD_URL
==SUPPRESS==
--cdash-build CDASH_BUILD
==SUPPRESS==
--cdash-site CDASH_SITE
==SUPPRESS==
--cdash-track CDASH_TRACK
==SUPPRESS==
--cdash-buildstamp CDASH_BUILDSTAMP
==SUPPRESS==

spack license

list and check license headers on files in spack

spack license [-h] SUBCOMMAND ...

Optional arguments

-h, --help
show this help message and exit

Subcommands


spack license list-files

spack license list-files [-h]

Optional arguments

-h, --help
show this help message and exit

spack license verify

spack license verify [-h] [--root ROOT]

Optional arguments

-h, --help
show this help message and exit
--root ROOT
scan a different prefix for license issues

spack list

list and search available packages

spack list [-hd] [--format {name_only,version_json,html}] [--update FILE] [-t TAGS] ...

More documentation

Positional arguments

filter
optional case-insensitive glob patterns to filter results

Optional arguments

-h, --help
show this help message and exit
-d, --search-description
filtering will also search the description for a match
--format {name_only,version_json,html}
format to be used to print the output [default: name_only]
--update FILE
write output to the specified file, if any package is newer
-t TAGS, --tags TAGS
filter a package query by tags

spack load

add package to the user environment

spack load [-hr] [--sh | --csh | --fish] [--first] [--only {package,dependencies}] ...

More documentation

Positional arguments

installed_specs
one or more installed package specs

Optional arguments

-h, --help
show this help message and exit
-r, --dependencies
recursively traverse spec dependencies
--sh
print sh commands to load the package
--csh
print csh commands to load the package
--fish
print fish commands to load the package
--first
load the first match if multiple packages match the spec
--only {package,dependencies}
select whether to load the package and its dependencies the default is to load the package and all dependencies alternatively one can decide to load only the package or only the dependencies

spack location

print out locations of packages and spack directories

spack location [-h] [-m | -r | -i | -p | -P | -s | -S | -b | -e ENV] ...

More documentation

Positional arguments

spec
package spec

Optional arguments

-h, --help
show this help message and exit
-m, --module-dir
spack python module directory
-r, --spack-root
spack installation root
-i, --install-dir
install prefix for spec (spec need not be installed)
-p, --package-dir
directory enclosing a spec’s package.py file
-P, --packages
top-level packages directory for Spack
-s, --stage-dir
stage directory for a spec
-S, --stages
top level stage directory
-b, --build-dir
checked out or expanded source directory for a spec (requires it to be staged first)
-e ENV, --env ENV
location of an environment managed by spack

spack log-parse

filter errors and warnings from build logs

spack log-parse [-hp] [--show SHOW] [-c CONTEXT] [-w WIDTH] [-j JOBS] file

Positional arguments

file
a log file containing build output, or - for stdin

Optional arguments

-h, --help
show this help message and exit
--show SHOW
comma-separated list of what to show; options: errors, warnings
-c CONTEXT, --context CONTEXT
lines of context to show around lines of interest
-p, --profile
print out a profile of time spent in regexes during parse
-w WIDTH, --width WIDTH
wrap width: auto-size to terminal by default; 0 for no wrap
-j JOBS, --jobs JOBS
number of jobs to parse log file (default: 1 for short logs, ncpus for long logs)

spack maintainers

get information about package maintainers

spack maintainers [-ha] [--maintained | --unmaintained] [--by-user] ...

Positional arguments

package_or_user
names of packages or users to get info for

Optional arguments

-h, --help
show this help message and exit
--maintained
show names of maintained packages
--unmaintained
show names of unmaintained packages
-a, --all
show maintainers for all packages
--by-user
show packages for users instead of users for packages

spack mirror

manage mirrors (source and binary)

spack mirror [-hn] SUBCOMMAND ...

More documentation

Optional arguments

-h, --help
show this help message and exit
-n, --no-checksum
do not use checksums to verify downloaded files (unsafe)

Subcommands


spack mirror create

spack mirror create [-haD] [-d DIRECTORY] [-f FILE] [--exclude-file EXCLUDE_FILE] [--exclude-specs EXCLUDE_SPECS]
                [--skip-unstable-versions] [-n VERSIONS_PER_SPEC]
                ...

More documentation

Positional arguments

specs
one or more package specs

Optional arguments

-h, --help
show this help message and exit
-d DIRECTORY, --directory DIRECTORY
directory in which to create mirror
-a, --all
mirror all versions of all packages in Spack, or all packages in the current environment if there is an active environment (this requires significant time and space)
-f FILE, --file FILE
file with specs of packages to put in mirror
--exclude-file EXCLUDE_FILE
specs which Spack should not try to add to a mirror (listed in a file, one per line)
--exclude-specs EXCLUDE_SPECS
specs which Spack should not try to add to a mirror (specified on command line)
--skip-unstable-versions
don’t cache versions unless they identify a stable (unchanging) source code
-D, --dependencies
also fetch all dependencies
-n VERSIONS_PER_SPEC, --versions-per-spec VERSIONS_PER_SPEC
the number of versions to fetch for each spec, choose ‘all’ to retrieve all versions of each package

spack mirror add

spack mirror add [-h] [--scope {defaults,system,site,user}[/PLATFORM]] mirror url

More documentation

Positional arguments

mirror
mnemonic name for mirror
url
url of mirror directory from ‘spack mirror create’

Optional arguments

-h, --help
show this help message and exit
--scope {defaults,system,site,user}[/PLATFORM]
configuration scope to modify

spack mirror remove

spack mirror remove [-h] [--scope {defaults,system,site,user}[/PLATFORM]] mirror

More documentation

Positional arguments

mirror
mnemonic name for mirror

Optional arguments

-h, --help
show this help message and exit
--scope {defaults,system,site,user}[/PLATFORM]
configuration scope to modify

spack mirror set-url

spack mirror set-url [-h] [--push] [--scope {defaults,system,site,user}[/PLATFORM]] mirror url

Positional arguments

mirror
mnemonic name for mirror
url
url of mirror directory from ‘spack mirror create’

Optional arguments

-h, --help
show this help message and exit
--push
set only the URL used for uploading new packages
--scope {defaults,system,site,user}[/PLATFORM]
configuration scope to modify

spack mirror list

spack mirror list [-h] [--scope {defaults,system,site,user}[/PLATFORM]]

More documentation

Optional arguments

-h, --help
show this help message and exit
--scope {defaults,system,site,user}[/PLATFORM]
configuration scope to read from

spack module

manipulate module files

spack module [-h] SUBCOMMAND ...

Optional arguments

-h, --help
show this help message and exit

Subcommands


spack module lmod

spack module lmod [-h] SUBCOMMAND ...

Optional arguments

-h, --help
show this help message and exit

Subcommands


spack module lmod refresh

spack module lmod refresh [-hy] [--delete-tree] [--upstream-modules] ...

Positional arguments

installed_specs
constraint to select a subset of installed packages

Optional arguments

-h, --help
show this help message and exit
--delete-tree
delete the module file tree before refresh
--upstream-modules
generate modules for packages installed upstream
-y, --yes-to-all
assume “yes” is the answer to every confirmation request

spack module lmod find

spack module lmod find [-hr] [--full-path] ...

Positional arguments

installed_specs
constraint to select a subset of installed packages

Optional arguments

-h, --help
show this help message and exit
--full-path
display full path to module file
-r, --dependencies
recursively traverse spec dependencies

spack module lmod rm

spack module lmod rm [-hy] ...

Positional arguments

installed_specs
constraint to select a subset of installed packages

Optional arguments

-h, --help
show this help message and exit
-y, --yes-to-all
assume “yes” is the answer to every confirmation request

spack module lmod loads

spack module lmod loads [-hr] [--input-only] [-p PREFIX] [-x EXCLUDE] ...

Positional arguments

installed_specs
constraint to select a subset of installed packages

Optional arguments

-h, --help
show this help message and exit
--input-only
generate input for module command (instead of a shell script)
-p PREFIX, --prefix PREFIX
prepend to module names when issuing module load commands
-x EXCLUDE, --exclude EXCLUDE
exclude package from output; may be specified multiple times
-r, --dependencies
recursively traverse spec dependencies

spack module lmod setdefault

spack module lmod setdefault [-h] ...

Positional arguments

installed_specs
constraint to select a subset of installed packages

Optional arguments

-h, --help
show this help message and exit

spack module tcl

spack module tcl [-h] SUBCOMMAND ...

Optional arguments

-h, --help
show this help message and exit

Subcommands


spack module tcl refresh

spack module tcl refresh [-hy] [--delete-tree] [--upstream-modules] ...

Positional arguments

installed_specs
constraint to select a subset of installed packages

Optional arguments

-h, --help
show this help message and exit
--delete-tree
delete the module file tree before refresh
--upstream-modules
generate modules for packages installed upstream
-y, --yes-to-all
assume “yes” is the answer to every confirmation request

spack module tcl find

spack module tcl find [-hr] [--full-path] ...

Positional arguments

installed_specs
constraint to select a subset of installed packages

Optional arguments

-h, --help
show this help message and exit
--full-path
display full path to module file
-r, --dependencies
recursively traverse spec dependencies

spack module tcl rm

spack module tcl rm [-hy] ...

Positional arguments

installed_specs
constraint to select a subset of installed packages

Optional arguments

-h, --help
show this help message and exit
-y, --yes-to-all
assume “yes” is the answer to every confirmation request

spack module tcl loads

spack module tcl loads [-hr] [--input-only] [-p PREFIX] [-x EXCLUDE] ...

Positional arguments

installed_specs
constraint to select a subset of installed packages

Optional arguments

-h, --help
show this help message and exit
--input-only
generate input for module command (instead of a shell script)
-p PREFIX, --prefix PREFIX
prepend to module names when issuing module load commands
-x EXCLUDE, --exclude EXCLUDE
exclude package from output; may be specified multiple times
-r, --dependencies
recursively traverse spec dependencies

spack patch

patch expanded archive sources in preparation for install

spack patch [-hn] ...

More documentation

Positional arguments

specs
one or more package specs

Optional arguments

-h, --help
show this help message and exit
-n, --no-checksum
do not use checksums to verify downloaded files (unsafe)

spack pkg

query packages associated with particular git revisions

spack pkg [-h] SUBCOMMAND ...

Optional arguments

-h, --help
show this help message and exit

Subcommands


spack pkg add

spack pkg add [-h] package [package ...]

Positional arguments

package
one or more package names

Optional arguments

-h, --help
show this help message and exit

spack pkg list

spack pkg list [-h] [rev]

Positional arguments

rev
revision to list packages for

Optional arguments

-h, --help
show this help message and exit

spack pkg diff

spack pkg diff [-h] [rev1] [rev2]

Positional arguments

rev1
revision to compare against
rev2
revision to compare to rev1 (default is HEAD)

Optional arguments

-h, --help
show this help message and exit

spack pkg added

spack pkg added [-h] [rev1] [rev2]

Positional arguments

rev1
revision to compare against
rev2
revision to compare to rev1 (default is HEAD)

Optional arguments

-h, --help
show this help message and exit

spack pkg changed

spack pkg changed [-h] [-t TYPE] [rev1] [rev2]

Positional arguments

rev1
revision to compare against
rev2
revision to compare to rev1 (default is HEAD)

Optional arguments

-h, --help
show this help message and exit
-t TYPE, --type TYPE
Types of changes to show (A: added, R: removed, C: changed); default is ‘C’

spack pkg removed

spack pkg removed [-h] [rev1] [rev2]

Positional arguments

rev1
revision to compare against
rev2
revision to compare to rev1 (default is HEAD)

Optional arguments

-h, --help
show this help message and exit

spack providers

list packages that provide a particular virtual package

spack providers [-h] [virtual_package [virtual_package ...]]

More documentation

Positional arguments

virtual_package
find packages that provide this virtual package

Optional arguments

-h, --help
show this help message and exit

spack pydoc

run pydoc from within spack

spack pydoc [-h] entity

Positional arguments

entity
run pydoc help on entity

Optional arguments

-h, --help
show this help message and exit

spack python

launch an interpreter as spack would launch a command

spack python [-hV] [-c PYTHON_COMMAND] [-m MODULE] ...

More documentation

Positional arguments

python_args
file to run plus arguments

Optional arguments

-h, --help
show this help message and exit
-V, --version
print the Python version number and exit
-c PYTHON_COMMAND
command to execute
-m MODULE
run library module as a script

spack reindex

rebuild Spack’s package database

spack reindex [-h]

Optional arguments

-h, --help
show this help message and exit

spack remove

remove specs from an environment

spack remove [-haf] [-l LIST_NAME] ...

Positional arguments

specs
one or more package specs

Optional arguments

-h, --help
show this help message and exit
-a, --all
remove all specs from (clear) the environment
-l LIST_NAME, --list-name LIST_NAME
name of the list to remove specs from
-f, --force
remove concretized spec (if any) immediately

spack repo

manage package source repositories

spack repo [-h] SUBCOMMAND ...

More documentation

Optional arguments

-h, --help
show this help message and exit

Subcommands


spack repo create

spack repo create [-h] directory [namespace]

Positional arguments

directory
directory to create the repo in
namespace
namespace to identify packages in the repository. defaults to the directory name

Optional arguments

-h, --help
show this help message and exit

spack repo list

spack repo list [-h] [--scope {defaults,system,site,user}[/PLATFORM]]

Optional arguments

-h, --help
show this help message and exit
--scope {defaults,system,site,user}[/PLATFORM]
configuration scope to read from

spack repo add

spack repo add [-h] [--scope {defaults,system,site,user}[/PLATFORM]] path

Positional arguments

path
path to a Spack package repository directory

Optional arguments

-h, --help
show this help message and exit
--scope {defaults,system,site,user}[/PLATFORM]
configuration scope to modify

spack repo remove

spack repo remove [-h] [--scope {defaults,system,site,user}[/PLATFORM]] namespace_or_path

Positional arguments

namespace_or_path
namespace or path of a Spack package repository

Optional arguments

-h, --help
show this help message and exit
--scope {defaults,system,site,user}[/PLATFORM]
configuration scope to modify

spack resource

list downloadable resources (tarballs, repos, patches, etc.)

spack resource [-h] SUBCOMMAND ...

More documentation

Optional arguments

-h, --help
show this help message and exit

Subcommands


spack resource list

spack resource list [-h] [--only-hashes]

Optional arguments

-h, --help
show this help message and exit
--only-hashes
only print sha256 hashes of resources

spack resource show

spack resource show [-h] hash

Positional arguments

hash

Optional arguments

-h, --help
show this help message and exit

spack restage

revert checked out package source code

spack restage [-h] ...

More documentation

Positional arguments

specs
one or more package specs

Optional arguments

-h, --help
show this help message and exit

spack setup

create a configuration script and module, but don’t build

spack setup [-hinv] [--clean | --dirty] ...

Positional arguments

spec
package spec

Optional arguments

-h, --help
show this help message and exit
-i, --ignore-dependencies
do not try to install dependencies of requested packages
-n, --no-checksum
do not use checksums to verify downloaded files (unsafe)
-v, --verbose
display verbose build output while installing
--clean
unset harmful variables in the build environment (default)
--dirty
preserve user environment in spack’s build environment (danger!)

spack spec

show what would be installed, given a spec

spack spec [-hlLIyjNt] [-c {nodes,edges,paths}] ...

More documentation

Positional arguments

specs
one or more package specs

Optional arguments

-h, --help
show this help message and exit
-l, --long
show dependency hashes as well as versions
-L, --very-long
show full dependency hashes as well as versions
-I, --install-status
show install status of packages. packages can be: installed [+], missing and needed by an installed package [-], or not installed (no annotation)
-y, --yaml
print concrete spec as YAML
-j, --json
print concrete spec as JSON
-c {nodes,edges,paths}, --cover {nodes,edges,paths}
how extensively to traverse the DAG (default: nodes)
-N, --namespaces
show fully qualified package names
-t, --types
show dependency types

spack stage

expand downloaded archive in preparation for install

spack stage [-hn] [-p PATH] ...

More documentation

Positional arguments

specs
one or more package specs

Optional arguments

-h, --help
show this help message and exit
-n, --no-checksum
do not use checksums to verify downloaded files (unsafe)
-p PATH, --path PATH
path to stage package, does not add to spack tree

spack test

run spack’s unit tests (wrapper around pytest)

spack test [-hHlLNs] [--extension EXTENSION] [-k EXPRESSION] [--showlocals] ...

More documentation

Positional arguments

pytest_args
arguments for pytest

Optional arguments

-h, --help
show this help message and exit
-H, --pytest-help
show full pytest help, with advanced options
-l, --list
list test filenames
-L, --list-long
list all test functions
-N, --list-names
list full names of all tests
--extension EXTENSION
run test for a given spack extension
-s
print output while tests run (disable capture)
-k EXPRESSION
filter tests by keyword (can also use w/list options)
--showlocals
show local variable values in tracebacks

spack undevelop

remove specs from an environment

spack undevelop [-ha] ...

Positional arguments

specs
one or more package specs

Optional arguments

-h, --help
show this help message and exit
-a, --all
remove all specs from (clear) the environment

spack uninstall

remove installed packages

spack uninstall [-hfRya] ...

More documentation

Positional arguments

installed_specs
one or more installed package specs

Optional arguments

-h, --help
show this help message and exit
-f, --force
remove regardless of whether other packages or environments depend on this one
-R, --dependents
also uninstall any packages that depend on the ones given via command line
-y, --yes-to-all
assume “yes” is the answer to every confirmation request
-a, --all
remove ALL installed packages that match each supplied spec

spack unload

remove package from the user environment

spack unload [-ha] [--sh | --csh | --fish] ...

Positional arguments

installed_specs
one or more installed package specs

Optional arguments

-h, --help
show this help message and exit
--sh
print sh commands to activate the environment
--csh
print csh commands to activate the environment
--fish
print fish commands to load the package
-a, --all
unload all loaded Spack packages.

spack url

debugging tool for url parsing

spack url [-h] SUBCOMMAND ...

More documentation

Optional arguments

-h, --help
show this help message and exit

Subcommands


spack url parse

spack url parse [-hs] url

Positional arguments

url
url to parse

Optional arguments

-h, --help
show this help message and exit
-s, --spider
spider the source page for versions

spack url list

spack url list [-hce] [-n | -N | -v | -V]

Optional arguments

-h, --help
show this help message and exit
-c, --color
color the parsed version and name in the urls shown (versions will be cyan, name red)
-e, --extrapolation
color the versions used for extrapolation as well (additional versions will be green, names magenta)
-n, --incorrect-name
only list urls for which the name was incorrectly parsed
-N, --correct-name
only list urls for which the name was correctly parsed
-v, --incorrect-version
only list urls for which the version was incorrectly parsed
-V, --correct-version
only list urls for which the version was correctly parsed

spack url summary

spack url summary [-h]

Optional arguments

-h, --help
show this help message and exit

spack url stats

spack url stats [-h]

Optional arguments

-h, --help
show this help message and exit

spack verify

Check that all spack packages are on disk as installed

spack verify [-hlja] [-s | -f] ...

Positional arguments

specs_or_files
Specs or files to verify

Optional arguments

-h, --help
show this help message and exit
-l, --local
Verify only locally installed packages
-j, --json
Ouptut json-formatted errors
-a, --all
Verify all packages
-s, --specs
Treat entries as specs (default)
-f, --files
Treat entries as absolute filenames. Cannot be used with ‘-a’

spack versions

list available versions of a package

spack versions [-hs] [-c CONCURRENCY] package

More documentation

Positional arguments

package
package name

Optional arguments

-h, --help
show this help message and exit
-s, --safe-only
only list safe versions of the package
-c CONCURRENCY, --concurrency CONCURRENCY
number of concurrent requests

spack view

project packages to a compact naming scheme on the filesystem.

spack view [-hv] [-e EXCLUDE] [-d {true,false,yes,no}] ACTION ...

More documentation

Optional arguments

-h, --help
show this help message and exit
-v, --verbose
If not verbose only warnings/errors will be printed.
-e EXCLUDE, --exclude EXCLUDE
exclude packages with names matching the given regex pattern
-d {true,false,yes,no}, --dependencies {true,false,yes,no}
Link/remove/list dependencies.

Subcommands


spack view copy

spack view copy [-hi] [--projection-file PROJECTION_FILE] path spec [spec ...]

Positional arguments

path
path to file system view directory
spec
seed specs of the packages to view

Optional arguments

-h, --help
show this help message and exit
--projection-file PROJECTION_FILE
Initialize view using projections from file.

-i, --ignore-conflicts


spack view remove

spack view remove [-ha] [--no-remove-dependents] path [spec [spec ...]]

Positional arguments

path
path to file system view directory
spec
seed specs of the packages to view

Optional arguments

-h, --help
show this help message and exit
--no-remove-dependents
Do not remove dependents of specified specs.
-a, --all
act on all specs in view