Installing the Anaconda Enterprise CLI

Warning

The following process for installing the Anaconda Enterprise CLI results in a broken conda env. Follow the workaround described here instead, until the issue is addressed in a future release of Anaconda Enterprise.

If you want to be able to create and share channels and packages from your Anaconda repository using conda commands, you need to download and install the Anaconda Enterprise CLI. If you updated the platform’s TLS/SSL certificate, you can also use the AE CLI to configure the TLS/SSL certs for the repository.

Prerequisites:


  1. To install the CLI, run the following command, replacing anaconda.example.com with the fully-qualified domain name (FQDN) of your Anaconda Enterprise instance:

    conda install -kc https://anaconda.example.com/repository/conda/anaconda-enterprise anaconda-enterprise-cli cas-mirror git
    

Note

You’ll notice that running this command also installs cas-mirror, the package mirroring tool. For more information on package mirroring, see Configuring channels and packages.

  1. After the list of package dependencies has been resolved, type y to proceed with the installation.

Configuring the Anaconda Enterprise CLI

  1. To add the url of the Anaconda repository to the set of available sites, run the following command with the fully-qualified domain name (FQDN) of your Anaconda Enterprise instance:

    anaconda-enterprise-cli config set sites.master.url https://<your.domain.com>/repository/api
    
  2. Run the following command to configure the instance of Anaconda repository you will be using as the default site:

    anaconda-enterprise-cli config set default_site master
    
  3. To see a consolidated view of the configuration, run the following command:

    anaconda-enterprise-cli config view
    

The Anaconda Enterprise CLI reads configuration information from the following places:

System-level configuration: /etc/anaconda-platform/cli.yml

User-level configuration: $INSTALL_PREFIX/anaconda-platform/cli.yml and $HOME/.anaconda/anaconda-platform/cli.yml

To change how it’s configured, modify the appropriate cli.yml file(s), based on your needs.

Note

Changing configuration settings at the user level overrides any system-level configuration.


If you updated the platform’s TLS/SSL certificate, you can use the AE CLI to configure the certificates for the repository using the following commands:

$ anaconda-enterprise-cli config set ssl_verify true

# On Ubuntu
$ anaconda-enterprise-cli config set sites.master.ssl_verify /etc/ssl/certs/ca-certificates.crt

# On RHEL/CentOS
$ anaconda-enterprise-cli config set sites.master.ssl_verify /etc/pki/tls/certs/ca-bundle.crt

Logging in to the Anaconda Enterprise CLI

  1. Run this command to access the CLI:

    anaconda-enterprise-cli login
    
  2. Log in to the CLI using the same username and password that you use to log in the Anaconda Enterprise web interface:

    Username: <your-username>
    Password: <your-password>
    

Next Steps: You can now configure access to the source of the packages to be mirrored, whether an online repository or a tarball (if an air-gapped installation). Then you’ll be ready to begin mirroring channels and packages.