The Cloudsmith Developer Hub

Welcome to the Cloudsmith developer hub. You'll find comprehensive guides and documentation to help you start working with Cloudsmith as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    

Command-Line Interface

Latest Version @ Cloudsmith
Python Versions
PyPI Version
Codacy Badge
Code style: black

The Cloudsmith Command Line Interface (CLI) is a Py2/Py3 text-based interface to the API. This allows users, machines and other services to access and integrate smoothly with Cloudsmith without requiring explicit plugins or tools. Be awesome. Automate Everything.

The following (very out of date) GIF demonstrates a small slice of the CLI - View the full video on YouTube:

CLI Demonstration

You can also read our blog article that introduced the first version of the CLI and the Cloudsmith RESTful API.


Please see the changelog for the list of changes by version. The current version is displayed in the PyPi badge at the top.


The CLI currently supports the following commands (and sub-commands):

  • check: Check rate limits and service status.
  • copy|cp: Copy a package to another repository.
  • delete|rm: Delete a package from a repository.
  • docs: Launch the help website in your browser.
  • entitlements|ents: Manage the entitlements for a repository.
    • create|new: Create a new entitlement in a repository.
    • delete|rm: Delete an entitlement from a repository.
    • list|ls: List entitlements for a repository.
    • refresh: Refresh an entitlement in a repository.
    • sync: Sync entitlements from another repository.
    • update|set: Update (patch) a entitlement in a repository.
  • help: Display the delightful help message and exit.
  • list|ls: List distros, packages, repos and entitlements.
    • distros: List available distributions.
    • entitlements: List entitlements for a repository.
    • packages: List packages for a repository.
    • repos: List repositories for a namespace (owner).
  • move|mv: Move (promote) a package to another repo.
  • push|upload: Push (upload) a new package to a repository.
    • alpine: Push (upload) a new Alpine package upstream.
    • composer: Push (upload) a new Composer package upstream.
    • deb: Push (upload) a new Deb package upstream.
    • helm: Push (upload) a new Helm package upstream.
    • maven: Push (upload) a new Maven package upstream.
    • npm: Push (upload) a new Npm package upstream.
    • python: Push (upload) a new Python package upstream.
    • raw: Push (upload) a new Raw package upstream.
    • rpm: Push (upload) a new Rpm package upstream.
    • ruby: Push (upload) a new Ruby package upstream.
    • vagrant: Push (upload) a new Vagrant package upstream.
  • resync: Resynchronise a package in a repository.
  • status: Get the synchronisation status for a package.
  • token: Retrieve your API authentication token/key.
  • whoami: Retrieve your current authentication status.


You can install the latest CLI application from:

The simplest way is to use pip, such as:

pip install --upgrade cloudsmith-cli

Or you can get the latest pre-release version from Cloudsmith:

pip install --upgrade cloudsmith-cli --extra-index-url=


There are two configuration files used by the CLI:

  • config.ini: For non-credentials configuration.
  • credentials.ini: For credentials (authentication) configuration.

By default, the CLI will look for these in the following locations:

  • The current working directory.
  • A directory called cloudsmith in the OS-defined application directory. For example:
    • Linux: $HOME/.config/cloudsmith
      • Windows: C:\Users\YourName\AppData\cloudsmith

Both configuration files use the simple INI format, such as:


Non-Credentials (config.ini)

See the default config in GitHub:

You can specify the following configuration options:

  • api_host: The API host to connect to.
  • api_proxy: The API proxy to connect through.
  • api_user_agent: The user agent to use for requests.

Credentials (credentials.ini)

See the default config in GitHub:

You can specify the following configuration options:

  • api_key: The API key for authenticating with the API.

Getting Your API Key

You'll need to provide authentication to Cloudsmith for any CLI actions that result in accessing private data or making changes to resources (such as pushing a new package to a repository)..

With the CLI this is simple to do. You can retrieve your API key using the cloudsmith token command:

cloudsmith token
Repeat for confirmation:

Note: Please ensure you use your email for the 'Login' prompt and not your user slug/identifier.

The resulting output looks something like:

Retrieving API token for '' ... OK
Your API token is: 1234567890abcdef1234567890abcdef

Once you have your API key you can then put this into your credentials.ini, use it as an environment variable export CLOUDSMITH_API_KEY=your_key_here or pass it to the CLI using the -k your_key_here flag.

For convenience the CLI will ask you if you want to install the default configuration files, complete with your API key, if they don't already exist. Say 'y' or 'yes' to create the configuration files.

If the configuration files already exist, you'll have to manually put the API key into the configuration files, but the CLI will print out their locations.


Note: All of the examples in this section are uploading to the your-account user and the test repository. Please replace these with your own user/org and repository names.

Upload an Alpine Package

Assuming you have a package filename libjq-1.0.3.apk, representing libjq 1.0.3, for the Alpine v3.8 distribution (which has a cloudsmith identifier of alpine/v3.8):

cloudsmith push alpine your-account/your-repo/alpine/v3.8 libjq-1.0.3.apk

Upload a Cargo Package

Assuming you have a package filename your-package.crate, representing your-package, for Cargo:

cloudsmith push cargo your-account/your-repo your-package.crate

Upload a Composer Package

Assuming you have a package filename your-package.phar, representing your-package, for Composer:

cloudsmith push composer your-account/your-repo your-package.phar

Upload a Debian Package

Assuming you have a package filename libxml2-2.9.4-2.x86_64.deb, representing libxml 2.9.4, for the Ubuntu 16.04 distribution (which has a cloudsmith identifier of ubuntu/xenial):

cloudsmith push deb your-account/your-repo/ubuntu/xenial libxml2-2.9.4-2.x86_64.deb

Upload a Helm Package

Assuming you have a package filename your-package-1.0.0.tgz, representing your-package 1.0.0, for Helm:

cloudsmith push helm your-account/your-repo your-package-1.0.0.tgz

Upload a Maven Package

Assuming you have a package filename validation-api-1.0.0.GA.jar, representing validation-api 1.0.0, for Maven/Java:

cloudsmith push maven your-account/your-repo validation-api-1.0.0.GA.jar --pom-file=validation-api-1.0.0.GA.pom

Upload a Npm Package

Assuming you have a package filename cloudsmithjs-1.0.0.tgz, representing cloudsmith-js 1.0.0*, for Npm**:

cloudsmith push npm your-account/your-repo cloudsmithjs-1.0.0.tgz

Upload a Python Package

Assuming you have a package filename boto3-1.4.4.py2.p3-none-any.whl, representing boto3 1.4.4, for Python 2/3:

cloudsmith push python your-account/your-repo boto3-1.4.4.py2.p3-none-any.whl

Upload a Raw Package

Assuming you have a package filename, representing packaged assets:

cloudsmith push raw your-account/your-repo

Upload a RedHat Package

Assuming you have a package filename libxml2-2.9.4-2.el5.x86_64.rpm, representing libxml 2.9.4, for the RedHat Enterprise 5.0 distribution (which has a cloudsmith identifier of el/5):

cloudsmith push rpm your-account/your-repo/el/5 libxml2-2.9.4-2.el5.x86_64.rpm

Upload a Ruby Package

Assuming you have a package filename safe_yaml-1.0.4.gem, representing safe_yaml 1.0.4, for Ruby 2.3+:

cloudsmith push ruby your-account/your-repo safe_yaml-1.0.4.gem

Upload a Vagrant Package

Assuming you have a package filename, representing a Vagrant image for the Awesome OS (fictional, probably):

cloudsmith push vagrant your-account/your-repo --provider virtualbox

Upload multiple Debian Packages

You can also upload multiple packages in one go (all of the same distribution):

cloudsmith push deb your-account/your-repo/ubuntu/xenial libxml2-2.9.1-2.x86_64.deb libxml2-2.9.2-2.x86_64.deb libxml2-2.9.3-2.x86_64.deb


Yes! Please do contribute, this is why we love open source. Please see CONTRIBUTING for contribution guidelines when making code changes or raising issues for bug reports, ideas, discussions and/or questions (i.e. help required).


Copyright 2018 Cloudsmith Ltd

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
See the License for the specific language governing permissions and
limitations under the License.


This quality product was brought to you by Cloudsmith and the fine folks who have contributed.

Command-Line Interface

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.