=================
Command Reference
=================

.. raw:: html

    <ol class="arabic simple">
    <li><a class="reference internal" href="#repo-cli-anaconda"><span class="std std-ref">anaconda</span></a></li>
    <li><a class="reference external" href="https://api.anaconda.org/docs">API Reference</a></li>
    </ol>
    <p>Anaconda client is the command line interface (CLI) to Anaconda Repository.
    It can be used for logging in, logging out, managing your account,
    uploading files, generating access tokens, viewing tokens, and other
    tasks as shown by running</p>
    <p>anaconda -h</p>
    <p>The full command reference is shown below.</p>
    <div class="section" id="anaconda">
    <span id="repo-cli-anaconda"></span><h2>anaconda<a class="headerlink" href="#anaconda" title="Permalink to this headline">¶</a></h2>
    <p>Anaconda Repository command line manager</p>
    <div class="cli-group-title">optional arguments</div><dl class="dl-horizontal dl-multiline docutils"><dt>-h / --help</dt><dd>show this help message and exit</dd><dt>-V / --version</dt><dd>show program's version number and exit</dd></dl><div class="cli-group-title">output</div><dl class="dl-horizontal dl-multiline docutils"><dt>--show-traceback</dt><dd>Show the full traceback for chalmers user errors (default: tty)</dd><dt>--hide-traceback</dt><dd>Hide the full traceback for chalmers user errors</dd><dt>-v / --verbose</dt><dd>print debug information ot the console</dd><dt>-q / --quiet</dt><dd>Only show warnings or errors the console</dd><dt>--color</dt><dd>always display with colors</dd><dt>--no-color</dt><dd>never display with colors</dd></dl><div class="cli-group-title">anaconda-client options</div><dl class="dl-horizontal dl-multiline docutils"><dt>-t / --token</dt><dd>Authentication token to use. May be a token or a path to a file containing a token</dd><dt>-s / --site</dt><dd>select the anaconda-client site to use</dd></dl><div class="cli-group-title">Commands</div><dl class="dl-horizontal dl-multiline docutils"><dt>auth</dt><dd>Manage Authorization Tokens</dd><dt>build</dt><dd>Anaconda build client for continuous integration, testing and building packages</dd><dt>channel</dt><dd>[DEPRECATED in favor of label] 
    Manage your Anaconda Cloud channels</dd><dt>config</dt><dd>Anaconda client configuration</dd><dt>copy</dt><dd>Copy packages from one account to another</dd><dt>download</dt><dd>Download notebooks from Anaconda Cloud</dd><dt>groups</dt><dd>Manage Groups</dd><dt>label</dt><dd>Manage your Anaconda Cloud labels</dd><dt>login</dt><dd>Authenticate a user</dd><dt>logout</dt><dd>Log out from Anaconda Cloud</dd><dt>notebook</dt><dd>Interact with notebooks in anaconda.org</dd><dt>package</dt><dd>Package utils</dd><dt>remove</dt><dd>Remove an object from Anaconda Cloud. Must refer to the formal package name as it appears in the URL of the package. Also use anaconda show <USERNAME> to see list of pacakge names. Example: anaconda remove continuumio/empty-example-notebook</dd><dt>search</dt><dd>Search Anaconda Cloud</dd><dt>show</dt><dd>Show information about an object</dd><dt>upload</dt><dd>Upload packages to Anaconda Cloud</dd><dt>whoami</dt><dd>Print the information of the current user</dd><dt>worker</dt><dd>Anaconda build client for continuous integration, testing and building packages</dd></dl><div class="section" id="authentication">
    <h3>Authentication<a class="headerlink" href="#authentication" title="Permalink to this headline">¶</a></h3>
    <div class="section" id="auth">
    <h4>auth<a class="headerlink" href="#auth" title="Permalink to this headline">¶</a></h4>
    <p>Manage Authorization Tokens</p>
    <div class="cli-group-title">optional arguments</div><dl class="dl-horizontal dl-multiline docutils"><dt>-h / --help</dt><dd>show this help message and exit</dd><dt>-n / --name</dt><dd>A unique name so you can identify this token later. View your tokens at anaconda.org/settings/access</dd><dt>-o / --org / --organization</dt><dd>Set the token owner (must be an organization)</dd></dl><div class="cli-group-title">token creation arguments<p><p>These arguments are only valid with the <code>--create</code> action</p></p></div><dl class="dl-horizontal dl-multiline docutils"><dt>--strength</dt><dd>None</dd><dt>--strong</dt><dd>Create a longer token (default)</dd><dt>-w / --weak</dt><dd>Create a shorter token</dd><dt>--url</dt><dd>The url of the application that will use this token</dd><dt>--max-age</dt><dd>The maximum age in seconds that this token will be valid for</dd><dt>-s / --scopes</dt><dd>Scopes for token. For example if you want to limit this token to conda downloads only you would use --scopes "repo conda:download"</dd><dt>--out</dt><dd>None</dd></dl><div class="cli-group-title">actions</div><dl class="dl-horizontal dl-multiline docutils"><dt>-x / --list-scopes</dt><dd>list all authentication scopes</dd><dt>-l / --list</dt><dd>list all user authentication tokens</dd><dt>-r / --remove</dt><dd>remove authentication tokens</dd><dt>-c / --create</dt><dd>Create an authentication token</dd><dt>-i / --info / --current-info</dt><dd>Show information about the current authentication token</dd></dl><p>Manage Authentication tokens</p>
    <p>See also:</p>
    <ul class="simple">
    <li><a class="reference internal" href="managing-account.html#repo-using-tokens"><span class="std std-ref">Using Anaconda Repository Tokens</span></a></li>
    </ul>
    </div>
    <div class="section" id="login">
    <h4>login<a class="headerlink" href="#login" title="Permalink to this headline">¶</a></h4>
    <p>Authenticate a user</p>
    <div class="cli-group-title">optional arguments</div><dl class="dl-horizontal dl-multiline docutils"><dt>-h / --help</dt><dd>show this help message and exit</dd><dt>--hostname</dt><dd>Specify the host name of this login, this should be unique (default: 0212-wwarner.local)</dd><dt>--username</dt><dd>Specify your username. If this is not given, you will be prompted</dd><dt>--password</dt><dd>Specify your password. If this is not given, you will be prompted</dd></dl></div>
    <div class="section" id="whoami">
    <h4>whoami<a class="headerlink" href="#whoami" title="Permalink to this headline">¶</a></h4>
    <p>Print the information of the current user</p>
    <div class="cli-group-title">optional arguments</div><dl class="dl-horizontal dl-multiline docutils"><dt>-h / --help</dt><dd>show this help message and exit</dd></dl></div>
    </div>
    <div class="section" id="informational">
    <h3>Informational<a class="headerlink" href="#informational" title="Permalink to this headline">¶</a></h3>
    <div class="section" id="show">
    <h4>show<a class="headerlink" href="#show" title="Permalink to this headline">¶</a></h4>
    <p>Show information about an object</p>
    <div class="cli-group-title">positional arguments</div><dl class="dl-horizontal dl-multiline docutils"><dt></dt><dd>Package written as USER[/PACKAGE[/VERSION[/FILE]]]</dd></dl><div class="cli-group-title">optional arguments</div><dl class="dl-horizontal dl-multiline docutils"><dt>-h / --help</dt><dd>show this help message and exit</dd></dl><p>Show information about an object</p>
    <p>Examples:</p>
    <div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">anaconda</span> <span class="n">show</span> <span class="n">continuumio</span>
    <span class="n">anaconda</span> <span class="n">show</span> <span class="n">continuumio</span><span class="o">/</span><span class="n">python</span>
    <span class="n">anaconda</span> <span class="n">show</span> <span class="n">continuumio</span><span class="o">/</span><span class="n">python</span><span class="o">/</span><span class="mf">2.7</span><span class="o">.</span><span class="mi">5</span>
    <span class="n">anaconda</span> <span class="n">show</span> <span class="n">sean</span><span class="o">/</span><span class="n">meta</span><span class="o">/</span><span class="mf">1.2</span><span class="o">.</span><span class="mi">0</span><span class="o">/</span><span class="n">meta</span><span class="o">.</span><span class="n">tar</span><span class="o">.</span><span class="n">gz</span>
    </pre></div>
    </div>
    </div>
    <div class="section" id="search">
    <h4>search<a class="headerlink" href="#search" title="Permalink to this headline">¶</a></h4>
    <p>Search Anaconda Repository</p>
    <div class="cli-group-title">positional arguments</div><dl class="dl-horizontal dl-multiline docutils"><dt></dt><dd>Search string</dd></dl><div class="cli-group-title">optional arguments</div><dl class="dl-horizontal dl-multiline docutils"><dt>-h / --help</dt><dd>show this help message and exit</dd><dt>-t / --package-type</dt><dd>only search for packages of this type</dd></dl><p>Search Anaconda Repository for packages</p>
    </div>
    <div class="section" id="config">
    <h4>config<a class="headerlink" href="#config" title="Permalink to this headline">¶</a></h4>
    <p>Binstar configuration</p>
    <div class="cli-group-title">optional arguments</div><dl class="dl-horizontal dl-multiline docutils"><dt>-h / --help</dt><dd>show this help message and exit</dd><dt>--type</dt><dd>The type of the values in the set commands</dd></dl><div class="cli-group-title">actions</div><dl class="dl-horizontal dl-multiline docutils"><dt>--set</dt><dd>sets a new variable: name value</dd><dt>--get</dt><dd>get value: name</dd><dt>--remove</dt><dd>removes a variable</dd><dt>--show</dt><dd>show all variables</dd><dt>-f / --files</dt><dd>show the config file names</dd><dt>--show-sources</dt><dd>Display all identified config sources</dd></dl><div class="cli-group-title">location</div><dl class="dl-horizontal dl-multiline docutils"><dt>-u / --user</dt><dd>set a variable for this user</dd><dt>-s / --system / --site</dt><dd>set a variable for all users on this machine</dd></dl><p>anaconda-client configuration</p>
    <p>Get, Set, Remove or Show the anaconda-client configuration.</p>
    <p>anaconda-client sites</p>
    <p>anaconda-client sites are a mechanism to allow users to quickly switch
    between Anaconda Repository instances. This is primarily used for testing the
    anaconda alpha site. But also has applications for the on-site <a class="reference external" href="https://www.continuum.io/anaconda-overview">Anaconda
    Enterprise</a>.</p>
    <p>anaconda-client comes with two pre-configured sites <code class="docutils literal"><span class="pre">alpha</span></code> and
    <code class="docutils literal"><span class="pre">binstar</span></code> you may use these in one of two ways:</p>
    <ul>
    <li><p class="first">Invoke the anaconda command with the <code class="docutils literal"><span class="pre">-s/--site</span></code> option like this to use
    the alpha testing site:</p>
    <div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">anaconda</span> <span class="o">-</span><span class="n">s</span> <span class="n">alpha</span> <span class="n">whoami</span>
    </pre></div>
    </div>
    </li>
    <li><p class="first">Set a site as the default:</p>
    <div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">anaconda</span> <span class="n">config</span> <span class="o">--</span><span class="nb">set</span> <span class="n">default_site</span> <span class="n">alpha</span>
    <span class="n">anaconda</span> <span class="n">whoami</span>
    </pre></div>
    </div>
    </li>
    </ul>
    <p>Add a anaconda-client site</p>
    <p>After installing <a class="reference external" href="https://www.continuum.io/anaconda-overview">Anaconda
    Enterprise</a> you can add a site
    named <strong>site_name</strong> like this:</p>
    <div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">anaconda</span> <span class="n">config</span> <span class="o">--</span><span class="nb">set</span> <span class="n">sites</span><span class="o">.</span><span class="n">site_name</span><span class="o">.</span><span class="n">url</span> <span class="s2">&quot;http://&lt;anaconda-enterprise-ip&gt;:&lt;port&gt;/api&quot;</span>
    <span class="n">anaconda</span> <span class="n">config</span> <span class="o">--</span><span class="nb">set</span> <span class="n">default_site</span> <span class="n">site_name</span>
    </pre></div>
    </div>
    <p>Site Options VS Global Options</p>
    <p>All options can be set as global options - affecting all sites, or site
    options - affecting only one site</p>
    <p>By default options are set globally like this:</p>
    <div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">anaconda</span> <span class="n">config</span> <span class="o">--</span><span class="nb">set</span> <span class="n">OPTION</span> <span class="n">VALUE</span>
    </pre></div>
    </div>
    <p>If you want the option to be limited to a single site, prefix the option
    with <code class="docutils literal"><span class="pre">sites.site_name</span></code> like this:</p>
    <div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">anaconda</span> <span class="n">config</span> <span class="o">--</span><span class="nb">set</span> <span class="n">sites</span><span class="o">.</span><span class="n">site_name</span><span class="o">.</span><span class="n">OPTION</span> <span class="n">VALUE</span>
    </pre></div>
    </div>
    <p>Common anaconda-client configuration options</p>
    <ul class="simple">
    <li><code class="docutils literal"><span class="pre">url</span></code>: Set the anaconda api url (default: <a class="reference external" href="https://api.anaconda.org">https://api.anaconda.org</a>)</li>
    <li><code class="docutils literal"><span class="pre">verify_ssl</span></code>: Perform ssl validation on the https requests.
    verify_ssl may be <code class="docutils literal"><span class="pre">True</span></code>, <code class="docutils literal"><span class="pre">False</span></code> or a path to a root CA pem
    file.</li>
    </ul>
    <p>Toggle auto_register when doing anaconda upload</p>
    <p>The default is yes, automatically create a new package when uploading.
    If no, then an upload will fail if the package name does not already
    exist on the server.</p>
    <div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">anaconda</span> <span class="n">config</span> <span class="o">--</span><span class="nb">set</span> <span class="n">auto_register</span> <span class="n">yes</span><span class="o">|</span><span class="n">no</span>
    </pre></div>
    </div>
    </div>
    </div>
    <div class="section" id="managing-packages">
    <h3>Managing Packages<a class="headerlink" href="#managing-packages" title="Permalink to this headline">¶</a></h3>
    <div class="section" id="package">
    <h4>package<a class="headerlink" href="#package" title="Permalink to this headline">¶</a></h4>
    <p>Anaconda Repository package utilities</p>
    <div class="cli-group-title">positional arguments</div><dl class="dl-horizontal dl-multiline docutils"><dt></dt><dd>Package to operate on</dd></dl><div class="cli-group-title">optional arguments</div><dl class="dl-horizontal dl-multiline docutils"><dt>-h / --help</dt><dd>show this help message and exit</dd></dl><div class="cli-group-title">actions</div><dl class="dl-horizontal dl-multiline docutils"><dt>--add-collaborator</dt><dd>username of the collaborator you want to add</dd><dt>--list-collaborators</dt><dd>list all of the collaborators in a package</dd><dt>--create</dt><dd>Create a package</dd></dl><div class="cli-group-title">metadata arguments</div><dl class="dl-horizontal dl-multiline docutils"><dt>--summary</dt><dd>Set the package short summary</dd><dt>--license</dt><dd>Set the package license</dd><dt>--license-url</dt><dd>Set the package license url</dd></dl><div class="cli-group-title">privacy</div><dl class="dl-horizontal dl-multiline docutils"><dt>--personal</dt><dd>Set the package access to personal This package will be available only on your personal registries</dd><dt>--private</dt><dd>Set the package access to private This package will require authorized and authenticated access to install</dd></dl></div>
    <div class="section" id="upload">
    <span id="repo-cli-upload"></span><h4>upload<a class="headerlink" href="#upload" title="Permalink to this headline">¶</a></h4>
    <p>Upload packages to Anaconda Repository</p>
    <div class="cli-group-title">positional arguments</div><dl class="dl-horizontal dl-multiline docutils"><dt></dt><dd>Distributions to upload</dd></dl><div class="cli-group-title">optional arguments</div><dl class="dl-horizontal dl-multiline docutils"><dt>-h / --help</dt><dd>show this help message and exit</dd><dt>-c / --channel</dt><dd>[DEPRECATED]
    Add this file to a specific channel. Warning: if the file channels do not include "main",the file will not show up in your user channel</dd><dt>-l / --label</dt><dd>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 label</dd><dt>--no-progress</dt><dd>Don't show upload progress</dd><dt>-u / --user</dt><dd>User account or Organization, defaults to the current user</dd><dt>--no-register</dt><dd>Don't create a new package namespace if it does not exist</dd><dt>--register</dt><dd>Create a new package namespace if it does not exist</dd><dt>--build-id</dt><dd>Anaconda Cloud Build ID (internal only)</dd><dt>-i / --interactive</dt><dd>Run an interactive prompt if any packages are missing</dd><dt>-f / --fail</dt><dd>Fail if a package or release does not exist (default)</dd><dt>--force</dt><dd>Force a package upload regardless of errors</dd></dl><div class="cli-group-title">metadata options</div><dl class="dl-horizontal dl-multiline docutils"><dt>-p / --package</dt><dd>Defaults to the package name in the uploaded file</dd><dt>-v / --version</dt><dd>Defaults to the package version in the uploaded file</dd><dt>-s / --summary</dt><dd>Set the summary of the package</dd><dt>-t / --package-type</dt><dd>Set the package type, defaults to autodetect</dd><dt>-d / --description</dt><dd>description of the file(s)</dd><dt>--thumbnail</dt><dd>Notebook's thumbnail image</dd></dl><div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">anaconda</span> <span class="n">upload</span> <span class="n">CONDA_PACKAGE_1</span><span class="o">.</span><span class="n">bz2</span>
    <span class="n">anaconda</span> <span class="n">upload</span> <span class="n">notebook</span><span class="o">.</span><span class="n">ipynb</span>
    <span class="n">anaconda</span> <span class="n">upload</span> <span class="n">environment</span><span class="o">.</span><span class="n">yml</span>
    </pre></div>
    </div>
    <div class="section" id="see-also">
    <h5>See Also<a class="headerlink" href="#see-also" title="Permalink to this headline">¶</a></h5>
    <ul class="simple">
    <li><a class="reference internal" href="using.html#repo-uploading-conda-packages"><span class="std std-ref">Uploading a Conda Package</span></a></li>
    <li><a class="reference internal" href="using.html#repo-uploading-pypi-packages"><span class="std std-ref">Uploading a PyPI Package</span></a></li>
    </ul>
    </div>
    </div>
    <div class="section" id="label">
    <h4>label<a class="headerlink" href="#label" title="Permalink to this headline">¶</a></h4>
    <p>Manage your Anaconda Repository channels</p>
    <div class="cli-group-title">optional arguments</div><dl class="dl-horizontal dl-multiline docutils"><dt>-h / --help</dt><dd>show this help message and exit</dd><dt>-o / --organization</dt><dd>Manage an organizations labels</dd><dt>--copy</dt><dd>None</dd><dt>--list</dt><dd>list all labels for a user</dd><dt>--show</dt><dd>Show all of the files in a label</dd><dt>--lock</dt><dd>Lock a label</dd><dt>--unlock</dt><dd>Unlock a label</dd><dt>--remove</dt><dd>Remove a label</dd></dl></div>
    <div class="section" id="copy">
    <h4>copy<a class="headerlink" href="#copy" title="Permalink to this headline">¶</a></h4>
    <p>Copy packages from one account to another</p>
    <div class="cli-group-title">positional arguments</div><dl class="dl-horizontal dl-multiline docutils"><dt></dt><dd>Package - written as user/package/version[/filename] If filename is not given, copy all files in the version</dd></dl><div class="cli-group-title">optional arguments</div><dl class="dl-horizontal dl-multiline docutils"><dt>-h / --help</dt><dd>show this help message and exit</dd><dt>--to-owner</dt><dd>User account to copy package to (default: your account)</dd><dt>--from-channel</dt><dd>[DEPRECATED]Channel to copy packages from</dd><dt>--to-channel</dt><dd>[DEPRECATED]Channel to put all packages into</dd><dt>--from-label</dt><dd>Label to copy packages from</dd><dt>--to-label</dt><dd>Label to put all packages into</dd></dl></div>
    </div>
    </div>
