CLI Reference

condax

Install and execute applications packaged by conda.

Usage:

condax [OPTIONS] COMMAND [ARGS]...

Options:

  --version             Print version and exit
  --install-completion  Install completion for the current shell.
  --show-completion     Show completion for the current shell, to copy it or
                        customize the installation.

ensure-path

Ensure the condax links directory is on $PATH.

This can update shell configuration files like ~/.bashrc.

Usage:

condax ensure-path [OPTIONS]

inject

Inject a package into a condax managed environment.

This will install a package into an existing condax environment.

Usage:

condax inject [OPTIONS] PACKAGE EXTRA_PACKAGES...

Options:

  -c, --channel TEXT              Use the channels specified to install.  If
                                  not specified condax will default to using
                                  ['conda-forge', 'defaults'].
  --mamba                         Force using mamba.
  -l, --link-conflict [error|overwrite|skip]
                                  How to handle conflicts when a link with the
                                  same name already exists in
                                  `/home/runner/.local/bin`.  If `error` is
                                  specified, condax will exit with an error if
                                  the link already exists.  If `overwrite` is
                                  specified, condax will overwrite the
                                  existing link.  If `skip` is specified,
                                  condax will skip linking the conflicting
                                  executable.  \[default: error]
  --include-apps                  Adds applications of injected package to
                                  PATH.
  PACKAGE                         The condax environment inject into.
                                  \[required]
  EXTRA_PACKAGES...               Extra packages to install.  \[required]

install

Install a package with condax.

This will install a package into a new conda environment and link the executable provided by it to /home/runner/.local/bin.

Usage:

condax install [OPTIONS] PACKAGE

Options:

  -c, --channel TEXT              Use the channels specified to install.  If
                                  not specified condax will default to using
                                  ['conda-forge', 'defaults'].
  -l, --link-conflict [error|overwrite|skip]
                                  How to handle conflicts when a link with the
                                  same name already exists in
                                  `/home/runner/.local/bin`.  If `error` is
                                  specified, condax will exit with an error if
                                  the link already exists.  If `overwrite` is
                                  specified, condax will overwrite the
                                  existing link.  If `skip` is specified,
                                  condax will skip linking the conflicting
                                  executable.  \[default: error]
  --mamba                         Force using mamba.
  PACKAGE                         \[required]

prefix

Display the conda prefix for a condax package.

Usage:

condax prefix [OPTIONS] PACKAGE

Options:

  PACKAGE  \[required]

remove

Remove a package installed by condax.

This will remove a package installed with condax and destroy the underlying conda environment.

Usage:

condax remove [OPTIONS] PACKAGE

Options:

  PACKAGE  \[required]
  --mamba  Force using mamba.

update

Update package(s) installed by condax.

This will update the underlying conda environments(s) to the latest release of a package.

Usage:

condax update [OPTIONS] [PACKAGE]

Options:

  --all                           Set to update all packages installed by
                                  condax
  -l, --link-conflict [error|overwrite|skip]
                                  How to handle conflicts when a link with the
                                  same name already exists in
                                  `/home/runner/.local/bin`.  If `error` is
                                  specified, condax will exit with an error if
                                  the link already exists.  If `overwrite` is
                                  specified, condax will overwrite the
                                  existing link.  If `skip` is specified,
                                  condax will skip linking the conflicting
                                  executable.  \[default: error]
  --mamba                         Force using mamba.
  [PACKAGE]