CLI Reference#

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] [-n ENVIRONMENT | -p PATH] [--json] [--console CONSOLE]
               [-v] [-q] [-d] [-y] [--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#

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

Target Environment Specification#

-n, --name: Name of environment.
-p, --prefix: Full path to environment location (i.e. prefix).

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