CLI Reference#

conda workspace#

Auto-generated from the conda workspace argument parser.

Manage project-scoped multi-environment workspaces.

usage: conda workspace [-h] [--file FILE]
                       {init,install,lock,list,envs,info,add,remove,clean,activate,run,shell,import} ...

Positional Arguments#

subcmd: Possible choices: init, install, lock, list, envs, info, add, remove, clean, activate, run, shell, import

Named Arguments#

--file, -f: Path to a specific workspace manifest instead of auto-detection.

Sub-commands#

init#

Initialize a new workspace manifest.

conda workspace init [-h] [--format {pixi,conda,pyproject}] [--name NAME]
                     [--channel CHANNELS] [--platform PLATFORMS]

Named Arguments#

--format

Possible choices: pixi, conda, pyproject

Manifest format to generate (default: conda).

Default: 'conda'

--name

Workspace name (defaults to directory name).

--channel, -c

Channels to include (repeatable, default: conda-forge).

--platform

Platforms to support (repeatable, auto-detected if omitted).

install#

Install (create/update) workspace environments.

conda workspace install [-h] [--json] [--console CONSOLE] [-v] [-q] [-d] [-y]
                        [-e ENVIRONMENT] [--force-reinstall] [--locked]
                        [--frozen]

Named Arguments#

-e, --environment

Install only this environment (default: all).

--force-reinstall

Remove and recreate environments from scratch.

Default: False

--locked

Install from lockfiles, verifying they are up-to-date.

Default: False

--frozen

Install from existing lockfiles without checking freshness.

Default: False

Output, Prompt, and Flow Control Options#

--json

Report all output as json. Suitable for using conda programmatically.

Default: Null

--console

Select the backend to use for normal output rendering.

Default: Null

-v, --verbose

Can be used multiple times. Once for detailed output, twice for INFO logging, thrice for DEBUG logging, four times for TRACE logging.

Default: Null

-q, --quiet

Do not display progress bar.

Default: Null

-d, --dry-run

Only display what would have been done.

Default: False

-y, --yes

Sets any confirmation values to ‘yes’ automatically. Users will not be asked to confirm any adding, deleting, backups, etc.

Default: Null

lock#

Solve and generate lockfiles for workspace environments.

conda workspace lock [-h] [--json] [--console CONSOLE] [-v] [-q] [-d] [-y]
                     [-e ENVIRONMENT]

Named Arguments#

-e, --environment: Generate lockfile for this environment only (default: all).

Output, Prompt, and Flow Control Options#

--json

Report all output as json. Suitable for using conda programmatically.

Default: Null

--console

Select the backend to use for normal output rendering.

Default: Null

-v, --verbose

Can be used multiple times. Once for detailed output, twice for INFO logging, thrice for DEBUG logging, four times for TRACE logging.

Default: Null

-q, --quiet

Do not display progress bar.

Default: Null

-d, --dry-run

Only display what would have been done.

Default: False

-y, --yes

Sets any confirmation values to ‘yes’ automatically. Users will not be asked to confirm any adding, deleting, backups, etc.

Default: Null

list#

List packages in a workspace environment.

conda workspace list [-h] [--json] [--console CONSOLE] [-v] [-q] [-d] [-y]
                     [-e ENVIRONMENT]

Named Arguments#

-e, --environment

Environment to list packages for (default: default).

Default: 'default'

Output, Prompt, and Flow Control Options#

--json

Report all output as json. Suitable for using conda programmatically.

Default: Null

--console

Select the backend to use for normal output rendering.

Default: Null

-v, --verbose

Can be used multiple times. Once for detailed output, twice for INFO logging, thrice for DEBUG logging, four times for TRACE logging.

Default: Null

-q, --quiet

Do not display progress bar.

Default: Null

-d, --dry-run

Only display what would have been done.

Default: False

-y, --yes

Sets any confirmation values to ‘yes’ automatically. Users will not be asked to confirm any adding, deleting, backups, etc.

Default: Null

envs#

List environments defined in the workspace.

conda workspace envs [-h] [--json] [--console CONSOLE] [-v] [-q] [-d] [-y]
                     [--installed]

Named Arguments#

--installed

Only show installed environments.

Default: False

Output, Prompt, and Flow Control Options#

--json

Report all output as json. Suitable for using conda programmatically.

Default: Null

--console

Select the backend to use for normal output rendering.

Default: Null

-v, --verbose

Can be used multiple times. Once for detailed output, twice for INFO logging, thrice for DEBUG logging, four times for TRACE logging.

Default: Null

-q, --quiet

Do not display progress bar.

Default: Null

-d, --dry-run

Only display what would have been done.

Default: False

-y, --yes

Sets any confirmation values to ‘yes’ automatically. Users will not be asked to confirm any adding, deleting, backups, etc.

Default: Null

info#

Show workspace overview or environment details.

conda workspace info [-h] [--json] [--console CONSOLE] [-v] [-q] [-d] [-y]
                     [-e ENVIRONMENT]

Named Arguments#

-e, --environment: Show details for this environment (default: workspace overview).

Output, Prompt, and Flow Control Options#

--json

Report all output as json. Suitable for using conda programmatically.

Default: Null

--console

Select the backend to use for normal output rendering.

Default: Null

-v, --verbose

Can be used multiple times. Once for detailed output, twice for INFO logging, thrice for DEBUG logging, four times for TRACE logging.

Default: Null

-q, --quiet

Do not display progress bar.

Default: Null

-d, --dry-run

Only display what would have been done.

Default: False

-y, --yes

Sets any confirmation values to ‘yes’ automatically. Users will not be asked to confirm any adding, deleting, backups, etc.

Default: Null

add#

Add a dependency to the workspace.

conda workspace add [-h] [--json] [--console CONSOLE] [-v] [-q] [-d] [-y]
                    [-e ENVIRONMENT] [--feature FEATURE] [--pypi]
                    specs [specs ...]

Positional Arguments#

specs: Package specs to add (e.g. ‘numpy>=1.24’).

Named Arguments#

-e, --environment

Target environment (adds to its feature instead of default).

--feature

Target feature directly (overrides –environment).

--pypi

Add as a PyPI dependency instead of conda.

Default: False

Output, Prompt, and Flow Control Options#

--json

Report all output as json. Suitable for using conda programmatically.

Default: Null

--console

Select the backend to use for normal output rendering.

Default: Null

-v, --verbose

Can be used multiple times. Once for detailed output, twice for INFO logging, thrice for DEBUG logging, four times for TRACE logging.

Default: Null

-q, --quiet

Do not display progress bar.

Default: Null

-d, --dry-run

Only display what would have been done.

Default: False

-y, --yes

Sets any confirmation values to ‘yes’ automatically. Users will not be asked to confirm any adding, deleting, backups, etc.

Default: Null

remove#

Remove a dependency from the workspace.

conda workspace remove [-h] [--json] [--console CONSOLE] [-v] [-q] [-d] [-y]
                       [-e ENVIRONMENT] [--feature FEATURE] [--pypi]
                       specs [specs ...]

Positional Arguments#

specs: Package names to remove.

Named Arguments#

-e, --environment

Target environment.

--feature

Target feature directly.

--pypi

Remove a PyPI dependency.

Default: False

Output, Prompt, and Flow Control Options#

--json

Report all output as json. Suitable for using conda programmatically.

Default: Null

--console

Select the backend to use for normal output rendering.

Default: Null

-v, --verbose

Can be used multiple times. Once for detailed output, twice for INFO logging, thrice for DEBUG logging, four times for TRACE logging.

Default: Null

-q, --quiet

Do not display progress bar.

Default: Null

-d, --dry-run

Only display what would have been done.

Default: False

-y, --yes

Sets any confirmation values to ‘yes’ automatically. Users will not be asked to confirm any adding, deleting, backups, etc.

Default: Null

clean#

Remove installed workspace environments.

conda workspace clean [-h] [--json] [--console CONSOLE] [-v] [-q] [-d] [-y]
                      [-e ENVIRONMENT]

Named Arguments#

-e, --environment: Remove only this environment (default: all).

Output, Prompt, and Flow Control Options#

--json

Report all output as json. Suitable for using conda programmatically.

Default: Null

--console

Select the backend to use for normal output rendering.

Default: Null

-v, --verbose

Can be used multiple times. Once for detailed output, twice for INFO logging, thrice for DEBUG logging, four times for TRACE logging.

Default: Null

-q, --quiet

Do not display progress bar.

Default: Null

-d, --dry-run

Only display what would have been done.

Default: False

-y, --yes

Sets any confirmation values to ‘yes’ automatically. Users will not be asked to confirm any adding, deleting, backups, etc.

Default: Null

activate#

Print activation instructions for an environment.

conda workspace activate [-h] [-e ENVIRONMENT]

Named Arguments#

-e, --environment

Environment name (default: default).

Default: 'default'

run#

Run a command in a workspace environment.

conda workspace run [-h] [-e ENVIRONMENT] ...

Positional Arguments#

cmd: Command to run (use – to separate from options).

Named Arguments#

-e, --environment

Environment name (default: default).

Default: 'default'

shell#

Spawn a new shell with an environment activated.

conda workspace shell [-h] [-e ENVIRONMENT] ...

Positional Arguments#

cmd: Optional command to run in the spawned shell.

Named Arguments#

-e, --environment

Environment name (default: default).

Default: 'default'

import#

Import a manifest from another format into conda.toml.

conda workspace import [-h] [--json] [--console CONSOLE] [-v] [-q] [-d] [-y]
                       [-o OUTPUT]
                       file

Positional Arguments#

file: Manifest file to import (environment.yml, anaconda-project.yml, conda-project.yml, pixi.toml, pyproject.toml).

Named Arguments#

-o, --output: Output path (default: conda.toml in the current directory).

Output, Prompt, and Flow Control Options#

--json

Report all output as json. Suitable for using conda programmatically.

Default: Null

--console

Select the backend to use for normal output rendering.

Default: Null

-v, --verbose

Can be used multiple times. Once for detailed output, twice for INFO logging, thrice for DEBUG logging, four times for TRACE logging.

Default: Null

-q, --quiet

Do not display progress bar.

Default: Null

-d, --dry-run

Only display what would have been done.

Default: False

-y, --yes

Sets any confirmation values to ‘yes’ automatically. Users will not be asked to confirm any adding, deleting, backups, etc.

Default: Null

conda task#

Auto-generated from the conda task argument parser.

Run, list, and manage project tasks.

usage: conda task [-h] [--file FILE] {run,list,add,remove,export} ...

Positional Arguments#

subcmd: Possible choices: run, list, add, remove, export

Named Arguments#

--file, -f: Path to a specific task file instead of auto-detection.

Sub-commands#

run#

Run a task.

conda task run [-h] [--json] [--console CONSOLE] [-v] [-q] [-d] [-y]
               [-e ENVIRONMENT] [--clean-env] [--skip-deps] [--cwd CWD]
               [--templated]
               task_name [task_args ...]

Positional Arguments#

task_name

Name of the task to run.

task_args

Arguments to pass to the task.

Default: []

Named Arguments#

-e, --environment

Workspace environment to run in.

--clean-env

Run in a clean environment (minimal env vars).

Default: False

--skip-deps

Skip dependency tasks, run only the named task.

Default: False

--cwd

Override the working directory for the task.

--templated

Treat the command as a Jinja2 template (for ad-hoc commands).

Default: False

Output, Prompt, and Flow Control Options#

--json

Report all output as json. Suitable for using conda programmatically.

Default: Null

--console

Select the backend to use for normal output rendering.

Default: Null

-v, --verbose

Can be used multiple times. Once for detailed output, twice for INFO logging, thrice for DEBUG logging, four times for TRACE logging.

Default: Null

-q, --quiet

Do not display progress bar.

Default: Null

-d, --dry-run

Only display what would have been done.

Default: False

-y, --yes

Sets any confirmation values to ‘yes’ automatically. Users will not be asked to confirm any adding, deleting, backups, etc.

Default: Null

list#

List available tasks.

conda task list [-h] [--json] [--console CONSOLE] [-v] [-q] [-d] [-y]

Output, Prompt, and Flow Control Options#

--json

Report all output as json. Suitable for using conda programmatically.

Default: Null

--console

Select the backend to use for normal output rendering.

Default: Null

-v, --verbose

Can be used multiple times. Once for detailed output, twice for INFO logging, thrice for DEBUG logging, four times for TRACE logging.

Default: Null

-q, --quiet

Do not display progress bar.

Default: Null

-d, --dry-run

Only display what would have been done.

Default: False

-y, --yes

Sets any confirmation values to ‘yes’ automatically. Users will not be asked to confirm any adding, deleting, backups, etc.

Default: Null

add#

Add a task to the manifest.

conda task add [-h] [--json] [--console CONSOLE] [-v] [-q] [-d] [-y]
               [--depends-on [DEPENDS_ON ...]] [--description DESCRIPTION]
               task_name cmd

Positional Arguments#

task_name: Name for the new task.
cmd: Command string for the task.

Named Arguments#

--depends-on

Tasks this task depends on.

Default: []

--description

Human-readable description.

Output, Prompt, and Flow Control Options#

--json

Report all output as json. Suitable for using conda programmatically.

Default: Null

--console

Select the backend to use for normal output rendering.

Default: Null

-v, --verbose

Can be used multiple times. Once for detailed output, twice for INFO logging, thrice for DEBUG logging, four times for TRACE logging.

Default: Null

-q, --quiet

Do not display progress bar.

Default: Null

-d, --dry-run

Only display what would have been done.

Default: False

-y, --yes

Sets any confirmation values to ‘yes’ automatically. Users will not be asked to confirm any adding, deleting, backups, etc.

Default: Null

remove#

Remove a task from the manifest.

conda task remove [-h] [--json] [--console CONSOLE] [-v] [-q] [-d] [-y]
                  task_name

Positional Arguments#

task_name: Name of the task to remove.

Output, Prompt, and Flow Control Options#

--json

Report all output as json. Suitable for using conda programmatically.

Default: Null

--console

Select the backend to use for normal output rendering.

Default: Null

-v, --verbose

Can be used multiple times. Once for detailed output, twice for INFO logging, thrice for DEBUG logging, four times for TRACE logging.

Default: Null

-q, --quiet

Do not display progress bar.

Default: Null

-d, --dry-run

Only display what would have been done.

Default: False

-y, --yes

Sets any confirmation values to ‘yes’ automatically. Users will not be asked to confirm any adding, deleting, backups, etc.

Default: Null

export#

Export tasks to conda.toml format.

conda task export [-h] [--json] [--console CONSOLE] [-v] [-q] [-d] [-y]
                  [-o OUTPUT]

Named Arguments#

-o, --output: Write to a file instead of stdout.

Output, Prompt, and Flow Control Options#

--json

Report all output as json. Suitable for using conda programmatically.

Default: Null

--console

Select the backend to use for normal output rendering.

Default: Null

-v, --verbose

Can be used multiple times. Once for detailed output, twice for INFO logging, thrice for DEBUG logging, four times for TRACE logging.

Default: Null

-q, --quiet

Do not display progress bar.

Default: Null

-d, --dry-run

Only display what would have been done.

Default: False

-y, --yes

Sets any confirmation values to ‘yes’ automatically. Users will not be asked to confirm any adding, deleting, backups, etc.

Default: Null