Getting started — Anaconda documentation

Installing Anaconda Client ¶

You can use Anaconda Client command line interface (CLI) to:

Connect to and manage your Anaconda.org account.
Upload packages you have created.
Generate access tokens to allow access to private packages.

NOTE: Client is not necessary to search for and download packages.

This tool can be installed using an Anaconda Prompt or the Terminal application in three ways: with conda, with pip or with pip from source. Anaconda recommends using conda.

Option 1, conda:

conda install anaconda-client

Option 2, pip:

pip install anaconda-client

Option 3, installing with pip from source:

pip install git+https://github.com/Anaconda-Platform/anaconda-client

After installing, view the complete list of Client tasks with this command:

anaconda -h

Finding, downloading and installing packages ¶

Searching for public packages¶

Anaconda.org hosts hundreds of useful Python packages for a wide variety of applications. You do not need to be logged in, or even need a Anaconda.org account, to search for public packages, download and install them. You need an account only to access private packages without a token or to share your packages with others.

To search for packages:

In the top Search box, type part or all of the name of a program you are searching for, and then press Enter.
Packages that match your search string are displayed. To see more information, click the package name.

For more information, see Working with packages.

Refining your search results¶

You can filter search results using 3 filter controls:

Type: All, conda only, Standard Python only, Standard R only, or Notebooks.
Access: All, Public, Private (only available if you are logged in and have specific permissions), or Authenticated (only available if you are logged in).
Platform: All, source, linux-32, linux-64, linux-aarch64, linux-armv61, linux-armv71, linux-ppc641e, linux-s390x, noarch, osx-32, osx-64, win-32, or win-64.

Source packages are source code only, not yet built for any specific platform.

Noarch packages are built to work on all platforms.

Downloading and installing packages from Anaconda.org¶

You can download and install packages using Anaconda Navigator, the graphical user interface for Anaconda. Advanced users may prefer a terminal window or command prompt.

Using Navigator¶

Navigator is automatically installed when you install Anaconda®.

To download and install a package into its own environment:

Start Navigator by clicking its program icon on your desktop or in your programs menu.
Sign Navigator into Anaconda.org so you can search for packages marked as private. Click the top right Sign in to Anaconda Anaconda.org button and type your Anaconda.org username and password, then click the Login button.
On the Environments tab, in the far-right Search packages box, enter the name of the desired package.
In the list to the left of Channels, select either Not installed or All, then click the Search button.
Select the checkbox of the package you want to install, then click the Apply button.

For more information, see Navigator.

Using conda in a Terminal window or Anaconda Prompt¶

To download and install a package into its own environment:

Locate a package on Anaconda.org that you want to download, then click on the package name.
A detail page displays specific installation instructions for the current operating system. Copy and paste the full command into your terminal window.

For example, the command could be structured as:

conda install -c username packagename

NOTE: For the following examples to work, you need to have conda downloaded and installed.

TIP: Conda expands username to a URL such as https://anaconda.org/username, based on the settings in the .condarc file.

Building and uploading packages ¶

Open a Anaconda.org account to upload packages or to access private packages without a token.

To build and upload packages, install the Client command line interface (CLI). For more information, see Installing Anaconda Client.

Use the Terminal window or an Anaconda Prompt to perform the following steps.

Install Anaconda Client:
```
conda install anaconda-client
```
Log in to your Anaconda.org account:
```
anaconda login
```
At the prompt, enter your Anaconda.org username and password.

Choose the package you would like to build. For this example, download our public test package:

git clone https://github.com/Anaconda-Platform/anaconda-client
cd anaconda-client/example-packages/conda/

To build your test package, first install conda-build and turn off automatic Client uploading, then run the conda build command:
```
conda install conda-build
conda config --set anaconda_upload no
conda build .
```
Find the path to where the newly-built file was placed so you can use it in the next step:
```
conda build . --output
```
Upload your newly-built test package to your Anaconda.org account:
```
anaconda login
anaconda upload /your/path/conda-package.tar.bz2
```
NOTE: Replace /your/path/ with the actual path that you found in the previous step.

For more information, see conda packages.

Updating package metadata¶

Much of the metadata provided in your package’s meta.yaml file appears on your package’s download page. This is information like your package’s license, description, Git repository URL, and documentation URLs. For more information on what is usually contained in conda-build’s meta.yaml file, see the conda-build documentation.

Anaconda client automatically updates metadata defined in the meta.yaml file of your package upload, as long as the package version number has never been uploaded previously. To update your metadata without needing a new package version, use --force-metadata-update.

anaconda upload /your/path/conda-package.tar.bz2 --force-metadata-update

Sharing notebooks ¶

To share a Jupyter notebook–formerly IPython notebook–on Anaconda.org:

To Upload your notebook to Anaconda.org, open the Terminal or an Anaconda Prompt and enter:
```
anaconda upload my-notebook.ipynb
```
NOTE: Replace my-notebook with the actual name of your notebook.
You can see an HTML version of your notebook stored at:
```
http://notebooks.anaconda.org/<USERNAME>/my-notebook
```
NOTE: Replace <USERNAME> with your username, and my-notebook with the actual name of your notebook.
Anyone who has access to Anaconda.org can download your notebook. To download the notebook, open the Terminal or an Anaconda Prompt and enter:
```
anaconda download username/my-notebook
```
NOTE: Replace username with your username, and my-notebook with the actual name of your notebook.

Sharing environments ¶

To share an environment on Anaconda.org:

See the conda user guide to create and save a conda environment. Open the Terminal or an Anaconda Prompt and enter:
```
conda env export -n my-environment -f my-environment.yml
```
NOTE: Replace my-environment with the actual name of your environment.
Upload it to Anaconda.org either using the web interface or the anaconda upload command.
- Using the web interface:
  
  Go to https://anaconda.org/USERNAME/environments.
  
  NOTE: Replace USERNAME with your username.
  
  In the top right corner use the Upload button to upload your environment.
- Using the anaconda upload command from the Terminal window or an Anaconda Prompt:
```
anaconda upload my-environment.yml
```
  NOTE: Replace my-environment with the actual name of your environment.
You can see a list of your uploaded environments at:
```
http://envs.anaconda.org/<USERNAME>
```
NOTE: Replace <USERNAME> with your username.
Anyone can download and install your environment from Anaconda.org.
- Using the web interface:
  
  Go to https://anaconda.org/USERNAME/environments.
  
  NOTE: Replace USERNAME with the username.
  
  Select the environment, click the Files tab, and under the Names field click the file to download.
- Using the Terminal or an Anaconda Prompt:
```
conda env create user/my-environment
source activate my-environment
```
NOTE: Replace my-environment with the actual name of your environment.

Getting started¶

Installing Anaconda Client¶

Finding, downloading and installing packages¶