Command line interface#
All the software environment management functionality supported in Python (e.g. coiled.create_software_environment()) is also available via the command line.
The table below lists each software environment Python function along with its corresponding CLI command:
Python |
Command line |
|---|---|
|
|
|
|
|
|
|
|
CLI Reference#
coiled env create#
Create a Coiled software environment
coiled env create [OPTIONS]
Options
- -n, --name <name>#
Name of software environment, it must be lowercase.
- --container <container>#
Base docker image to use.
- --conda <conda>#
Conda environment file.
- --pip <pip>#
Pip requirements file.
- --post-build <post_build>#
Post-build script.
- --conda-env-name <conda_env_name>#
Name of conda environment to install packages into. Only use when using –container, and the image expects commands to run in a conda environment not named “coiled”
- --private, --no-private#
Flag to set software environment private.
- --force-rebuild#
Skip checks for an existing software environment build.
- -e, --environ <environ>#
Custom environment variable(s).
- --account <account>#
Account to use for creating this software environment.
- --new-build-backend, --no-new-build-backend#
Use the new build system
- Default
True
- --gpu-enabled#
Set CUDA virtual package for Conda
- Default
False
coiled env delete#
Delete a Coiled software environment
coiled env delete [OPTIONS] NAME
Options
- --new-build-backend, --no-new-build-backend#
Arguments
- NAME#
Required argument
coiled env list#
List the Coiled software environments in an account
coiled env list [OPTIONS] [ACCOUNT]
Options
- --new-build-backend, --no-new-build-backend#
Arguments
- ACCOUNT#
Optional argument
coiled env inspect#
View the details of a Coiled software environment
coiled env inspect [OPTIONS] NAME
Arguments
- NAME#
Required argument