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,export,list,envs,info,add,remove,clean,activate,run,shell,quickstart,import} ...

Positional Arguments#

subcmd: Possible choices: init, install, lock, export, list, envs, info, add, remove, clean, activate, run, shell, quickstart, 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] [--platform PLATFORM]
                     [--skip-unsolvable] [--output OUTPUT] [--merge PATH]

Named Arguments#

-e, --environment

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

--platform

Lock only for this platform (e.g. linux-64). May be passed multiple times. Defaults to all platforms declared in the workspace.

--skip-unsolvable

Continue locking when the solver fails for an (environment, platform) pair instead of aborting. Other errors (missing channel, invalid manifest, etc.) still abort. Fails if no pair can be solved.

Default: False

--output

Write the lockfile to this path instead of the default <workspace>/conda.lock. Useful in CI matrices that emit per-platform fragments (e.g. –platform linux-64 –output conda.lock.linux-64) to be stitched back with –merge.

--merge

Merge pre-existing conda.lock fragments into a single <workspace>/conda.lock without solving. May be passed multiple times; each value is treated as a glob (e.g. –merge ‘conda.lock.*’). Cannot be combined with –environment, –platform, –skip-unsolvable, or –output.

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 a workspace environment to environment.yml / conda.lock / …

conda workspace export [-h] [--json] [--console CONSOLE] [-v] [-q] [-d] [-y]
                       [-e ENVIRONMENT]
                       [--format {conda-lock-v1,conda-toml,conda-workspaces-lock,conda-workspaces-lock-v1,environment-json,environment-yaml,explicit,json,pixi-lock-v6,pixi-toml,pyproject-toml,rattler-lock-v6,reqs,requirements,txt,workspace-lock,yaml,yml}]
                       [-f FILE] [--platform EXPORT_PLATFORMS]
                       [--from-lockfile | --from-prefix] [--no-builds]
                       [--ignore-channels] [--from-history]

Named Arguments#

-e, --environment

Environment to export (default: default).

Default: 'default'

--format

Possible choices: conda-lock-v1, conda-toml, conda-workspaces-lock, conda-workspaces-lock-v1, environment-json, environment-yaml, explicit, json, pixi-lock-v6, pixi-toml, pyproject-toml, rattler-lock-v6, reqs, requirements, txt, workspace-lock, yaml, yml

Export format name or alias (e.g. environment-yaml, json, conda-workspaces-lock-v1). Defaults to environment-yaml when –file is omitted, or detected from –file’s basename.

-f, --file

Write output to this file (default: stdout).

--platform

Restrict export to this platform (e.g. linux-64). Repeatable. When multiple platforms are given, the chosen format must support multi-platform export (e.g. conda-workspaces-lock-v1).

--from-lockfile

Build the export from an existing conda.lock via the CondaLockLoader, instead of the declared manifest.

Default: False

--from-prefix

Build the export from the installed prefix, matching conda export semantics (enables –no-builds, –ignore-channels, –from-history).

Default: False

--no-builds

Omit build strings from the exported specs (requires –from-prefix).

Default: False

--ignore-channels

Do not include channel metadata (requires –from-prefix).

Default: False

--from-history

Export only explicit specs from the prefix’s history (requires –from-prefix).

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 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]
                    [--no-install] [--no-lockfile-update] [--force-reinstall]
                    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

--no-install

Update manifest and lockfile but skip installing into the environment.

Default: False

--no-lockfile-update

Only update the manifest; skip solving, lockfile, and install.

Default: False

--force-reinstall

Remove and recreate the affected environment(s) from scratch.

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]
                       [--no-install] [--no-lockfile-update]
                       [--force-reinstall]
                       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

--no-install

Update the manifest and lockfile but skip reinstalling the environment.

Default: False

--no-lockfile-update

Only update the manifest; skip solving, lockfile, and reinstall.

Default: False

--force-reinstall

Remove and recreate the affected environment(s) from scratch.

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'

quickstart#

Bootstrap a workspace in one command: init (or copy an existing manifest), add the given specs, install the environment, and drop into a shell.

conda workspace quickstart [-h] [--json] [--console CONSOLE] [-v] [-q] [-d]
                           [-y] [--format {pixi,conda,pyproject}]
                           [--name NAME] [--channel CHANNELS]
                           [--platform PLATFORMS] [-e ENVIRONMENT]
                           [--force-reinstall] [--locked] [--frozen]
                           [--copy COPY_FROM] [--no-shell]
                           [specs ...]

Positional Arguments#

specs

Optional package specs to add immediately (same grammar as conda workspace add, e.g. ‘python=3.14’ ‘numpy>=2.4’).

Default: []

Named Arguments#

--format

Possible choices: pixi, conda, pyproject

Manifest format for the generated workspace (default: conda). Ignored with a warning when –copy/–clone is used.

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).

-e, --environment

Environment to install and spawn a shell in (default: default).

Default: 'default'

--force-reinstall

Re-run install from scratch even if the environment exists.

Default: False

--locked

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

Default: False

--frozen

Install from existing lockfiles without checking freshness.

Default: False

--copy, --clone

Copy a source workspace’s manifest (conda.toml / pixi.toml / pyproject.toml) into the current directory instead of running init. Accepts a directory or a manifest file.

--no-shell

Skip the final conda workspace shell step (useful for CI).

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

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