Anaconda Client command reference
Anaconda Client is the command line interface (CLI) for Anaconda.org, and can be used for logging in, logging out, managing your account, uploading files, generating access tokens, viewing tokens, and more! Visit the Getting started with Anaconda Client page for installation instructions for the anaconda-client
package.
This page includes all Anaconda Client commands, their arguments, and their options.
Run anaconda --help
or anaconda <COMMAND> -h
in Anaconda Prompt (Terminal on macOS/Linux) to see this help text in your terminal.
Run the following commands in Anaconda Prompt (Terminal on macOS/Linux).
Looking for conda commands? See the official conda documentation for a full guide to conda commands.
In the command syntax, square brackets ([ ]
) mean a parameter is optional and angle brackets (< >
) mean it’s required. In the examples, angle brackets (< >
) indicate values you should replace with your own.
Global options
Show help message, version, or enable verbose output.
Usage: anaconda [GLOBAL OPTION]
Option | Short | Description |
---|---|---|
--verbose | -v | Print debug information to the console |
--version | -V | Show version and exit |
--help | -h | Show command information and exit |
Commands
config
Anaconda client configuration (alias for anaconda org config
).
Usage: anaconda config [OPTIONS]
Options
General Options
General Options
Option | Description |
---|---|
-h, --help | Show help message and exit |
--type TYPE | The type of the values in the set commands |
Actions
Actions
Option | Description |
---|---|
--set name value | Sets a new variable: name value |
--get name | Gets value: name |
--remove REMOVE | Removes a variable |
--show | Show all variables |
-f, --files | Show the config file names |
--show-sources | Display all identified config sources |
Location Options
Location Options
Option | Description |
---|---|
-u, --user | Set a variable for this user |
-s, --system, --site | Set a variable for all users on this machine |
Examples
copy
Copy packages from one account to another (alias for anaconda org copy
, defaults to copying to your account).
Usage: anaconda copy [OPTIONS] <SPEC>
Arguments
Argument | Description |
---|---|
<SPEC> | Package - written as user/package/version[/filename] . If filename is not given, copy all files in the version |
Options
General Options
General Options
Option | Description |
---|---|
-h, --help | Show help message and exit |
Copy Options
Copy Options
Option | Description |
---|---|
--to-owner TO_OWNER | User account to copy package to (default: your account) |
--from-label FROM_LABEL | Label to copy packages from |
--to-label TO_LABEL | Label to put all packages into |
--replace | Overwrite destination package metadata |
--update | Update missing data in destination package metadata |
Examples
download
Download packages from your Anaconda repository (alias for anaconda org download
).
Usage: anaconda download [OPTIONS] <HANDLE>
Arguments
Argument | Description |
---|---|
<HANDLE> | [CHANNEL_NAME/]<PACKAGE_NAME> |
Options
General Options
General Options
Option | Description |
---|---|
-h, --help | Show help message and exit |
Download Options
Download Options
Option | Description |
---|---|
-f, --force | Overwrite |
-o OUTPUT, --output OUTPUT | Download as |
-t PACKAGE_TYPE, --package-type PACKAGE_TYPE | Set the package type [conda , env , file , ipynb , pypi , r , project , installer ]. Defaults to downloading all package types available |
Examples
label
Manage your Anaconda repository channels (alias for anaconda org label
).
Usage: anaconda label [OPTIONS] <ACTION>
Options
General Options
General Options
Option | Description |
---|---|
-h, --help | Show help message and exit |
-o ORGANIZATION, --organization ORGANIZATION | Manage an organization’s labels |
Actions
Actions
Option | Description |
---|---|
--copy LABEL LABEL | Copy label |
--list | List all labels for a user |
--show LABEL | Show all of the files in a label |
--lock LABEL | Lock a label |
--unlock LABEL | Unlock a label |
--remove LABEL | Remove a label |
Examples
move
Move packages between labels (alias for anaconda org move
).
Usage: anaconda move [OPTIONS] <SPEC>
Arguments
Argument | Description |
---|---|
<SPEC> | Package - written as user/package/version[/filename] . If filename is not given, move all files in the version |
Options
General Options
General Options
Option | Description |
---|---|
-h, --help | Show help message and exit |
Move Options
Move Options
Option | Description |
---|---|
--from-label FROM_LABEL | Label to move packages from |
--to-label TO_LABEL | Label to move packages to |
Examples
package
Anaconda repository package utilities (alias for anaconda org package
).
Usage: anaconda package [OPTIONS] <USER/PACKAGE> <ACTION>
Arguments
Argument | Description |
---|---|
<USER/PACKAGE> | Package to operate on |
Options
General Options
General Options
Option | Description |
---|---|
-h, --help | Show help message and exit |
Actions
Actions
Option | Description |
---|---|
--add-collaborator USER | Username of the collaborator you want to add |
--list-collaborators | List all of the collaborators in a package |
--create | Create a package |
Metadata Arguments
Metadata Arguments
Option | Description |
---|---|
--summary SUMMARY | Set the package short summary |
--license LICENSE | Set the package license |
--license-url LICENSE_URL | Set the package license url |
Privacy
Privacy
Option | Description |
---|---|
--personal | Set the package access to personal. This package will be available only on your personal registries |
--private | Set the package access to private. This package will require authorized and authenticated access to install |
Examples
remove
Remove an object from your Anaconda repository.
Usage: anaconda remove [OPTIONS] <SPEC> [ADDITIONAL_SPECS ...]
Arguments
Argument | Description |
---|---|
<SPEC> | Package written as <user>[/<package>[/<version>[/<filename>]]] |
Options
General Options
General Options
Option | Description |
---|---|
-h, --help | Show help message and exit |
-f, --force | Do not prompt removal |
Examples
search
Search in your Anaconda repository (alias for anaconda org search
).
Usage: anaconda search [OPTIONS] <NAME>
For most use cases, conda search
is the preferred way to search for a package. If you installed with Anaconda Distribution or Miniconda, conda searches for packages in Anaconda’s default channels unless configured otherwise. The anaconda search
command searches all public channels on Anaconda.org and might return results that are not in the default channels. For more information on searching for packages with conda search
, see Searching for conda packages.
Arguments
Argument | Description |
---|---|
<NAME> | Search string |
Options
General Options
General Options
Option | Description |
---|---|
-h, --help | Show help message and exit |
Search Filters
Search Filters
Option | Description |
---|---|
-t PACKAGE_TYPE, --package-type PACKAGE_TYPE | Only search for packages of this type: [conda , env , file , ipynb , pypi , r , project , installer ] |
-p PLATFORM, --platform PLATFORM | Only search for packages of the chosen platform: [osx-32 , osx-64 , win-32 , win-64 , linux-32 , linux-64 , linux-aarch64 , linux-armv6l , linux-armv7l , linux-ppc64le , linux-s390x , noarch ] |
Examples
show
Show information about an object (alias for anaconda org show
).
Usage: anaconda show [OPTIONS] <SPEC>
Arguments
Argument | Description |
---|---|
<SPEC> | Package written as user[/package[/version[/file]]] |
Options
General Options
General Options
Option | Description |
---|---|
-h, --help | Show help message and exit |
Examples
update
Update public attributes of the package or the attributes of the package release (alias for anaconda org update
).
Usage: anaconda update [OPTIONS] <SPEC> <SOURCE>
Arguments
Argument | Description |
---|---|
<SPEC> | Package name written as user/package[/version] |
<SOURCE> | Path to the file that consists of metadata that will be updated in the destination package. It may be a valid package file or .json file with described attributes to update |
Options
General Options
General Options
Option | Description |
---|---|
-h, --help | Show help message and exit |
-t PACKAGE_TYPE, --package-type PACKAGE_TYPE | Set the package type. Defaults to autodetect |
Update Release
Update Release
Option | Description |
---|---|
--release | Use source file to update public attributes of the release specified in spec |
Examples
upload
Upload packages to your Anaconda repository (alias for anaconda org upload
).
Usage: anaconda upload [OPTIONS] <FILE> [FILES ...]
Arguments
Argument | Description |
---|---|
<FILE> | Distributions to upload |
Options
General Options
General Options
Option | Description |
---|---|
-h, --help | Show help message and exit |
--no-progress | Don’t show upload progress |
-u USER, --user USER | User account or organization; defaults to the current user |
--keep-basename | Do not normalize a basename when uploading a conda package. Note: this parameter only applies to conda, and not standard Python packages |
Label Options
Label Options
Option | Description |
---|---|
-l LABELS, --label LABELS | Add this file to a specific label. Warning: if the file labels do not include “main”, the file will not show up in your user labels |
Upload Behavior
Upload Behavior
Option | Description |
---|---|
--no-register | Don’t create a new package namespace if it does not exist |
--register | Create a new package namespace if it does not exist |
--build-id BUILD_ID | Anaconda repository build ID (internal only) |
-i, --interactive | Run an interactive prompt if any packages are missing |
-f, --fail | Fail if a package or release does not exist (default) |
--force | Force a package upload regardless of errors |
--skip-existing | Skip errors on package batch upload if it already exists |
-m, --force-metadata-update | Overwrite existing release metadata with the metadata from the package |
Metadata Options
Metadata Options
Option | Description |
---|---|
-p PACKAGE, --package PACKAGE | Defaults to the package name in the uploaded file |
-v VERSION, --version VERSION | Defaults to the package version in the uploaded file |
-s SUMMARY, --summary SUMMARY | Set the summary of the package |
-t PACKAGE_TYPE, --package-type PACKAGE_TYPE | Set the package type. Defaults to autodetect |
-d DESCRIPTION, --description DESCRIPTION | Description of the file(s) |
--thumbnail THUMBNAIL | Notebook’s thumbnail image |
--private | Create the package with private access |
Examples
See Also
Plugins
org
Interact with Anaconda.org.
Most anaconda org
commands have convenient aliases available at the top level (for example, anaconda upload
instead of anaconda org upload
). See Commands for detailed documentation.
Usage: anaconda org [OPTIONS] COMMAND [ARGS]...
Commands
Command | Description |
---|---|
auth | Manage authorization tokens |
config | Anaconda Client configuration |
copy | Copy packages from one account to another |
download | Download packages from your Anaconda repository |
groups | Group management |
label | Manage your Anaconda repository channels |
login | Authenticate a user |
logout | Log out from binstar |
move | Move packages between labels |
package | Anaconda repository package utilities |
remove | Remove an object from your Anaconda repository |
search | Search in your Anaconda repository |
show | Show information about an object |
update | Update public attributes of the package or the attributes of the package release |
upload | Upload packages to your Anaconda repository |
whoami | Print the information of the current user |
Examples
Authentication
login
Sign into Anaconda services.
Usage: anaconda login [OPTIONS]
Options
General Options
General Options
Option | Description |
---|---|
--at TEXT | Choose from [anaconda.com , anaconda.org ] [default: None] |
--help | Show help message and exit |
Examples
logout
Sign out from Anaconda services.
Usage: anaconda logout [OPTIONS]
Options
General Options
General Options
Option | Description |
---|---|
--at TEXT | Choose from [anaconda.com , anaconda.org ] [default: None] |
--help | Show help message and exit |
Examples
whoami
Display account information.
Usage: anaconda whoami [OPTIONS]
Options
General Options
General Options
Option | Description |
---|---|
--at TEXT | Choose from [anaconda.com , anaconda.org ] [default: None] |
--help | Show help message and exit |
Examples