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    

Raw Repository

Cloudsmith provides public & private repositories for Raw files

Cloudsmith supports "Raw" files. Any file, any extension, suitable for datasets, images or whatever you want to throw at it. You get all the benefits of a Cloudsmith repository such as CLI uploads for automation, fine-grained access controls and logging/statistics (among others) - but for any file type at all.

Contextual Documentation

The examples in this document are generic. Cloudsmith provides contextual setup instructions within each repository, complete with copy n' paste snippets (with your namespace/repo/rsa-key pre-configured).

In the following examples:

Identifier

Description

OWNER

Your Cloudsmith account name or organisation name (namespace)

REPOSITORY

Your Cloudsmith Repository name (also called "slug")

TOKEN

Your Cloudsmith Entitlement Token (see Entitlements for more details)

USERNAME

Your Cloudsmith username

PASSWORD

Your Cloudsmith password

API-KEY

Your Cloudsmith API Key

FILENAME

The name of your file (i.e file.zip or file.txt etc)

VERSION_NO

Optional version number for a package

Upload a File

Upload via the Cloudsmith CLI

For full details of how to install and setup the Cloudsmith CLI, see Command Line Interface.

The command to upload via the Cloudsmith CLI is:

cloudsmith push raw OWNER/REPOSITORY FILENAME

Example:

cloudsmith push raw your-account/your-repo file.zip

Upload via Cloudsmith Website

Please see Upload a Package for details of how to upload via the Website UI.


Download a Package

To download a Raw package, you'll need to fetch uploaded files using a well-crafted URL, for example:

Public Repositories

curl -O 'https://dl.cloudsmith.io/public/OWNER/REPOSITORY/raw/files/FILENAME'

If you have multiple versions of a package you can download a specific version with:

curl -O 'https://dl.cloudsmith.io/public/OWNER/REPOSITORY/raw/versions/VERSION_NO/FILENAME'

Or to get the latest version of the package, replace the version number with 'latest':

curl -O 'https://dl.cloudsmith.io/public/OWNER/REPOSITORY/raw/versions/latest/FILENAME'

Alternatively, when logged into Cloudsmith via a Web Browser, there's a green "Download" button that provides a link to download that file.

Private Repositories

📘

Private Cloudsmith repositories require authentication. You can choose between two types of authentication, Entitlement Token Authentication or HTTP Basic Authentication.

The download URL will differ depending on what authentication type you choose to use.

curl -O 'https://dl.cloudsmith.io/TOKEN/OWNER/REPOSITORY/raw/files/FILENAME'
curl -u "USERNAME:PASSWORD" -O 'https://dl.cloudsmith.io/basic/OWNER/REPOSITORY/raw/files/FILENAME'
curl -u "USERNAME:API-KEY" -O 'https://dl.cloudsmith.io/basic/OWNER/REPOSITORY/raw/files/FILENAME'
curl -u "token:TOKEN" -O 'https://dl.cloudsmith.io/basic/OWNER/REPOSITORY/raw/files/FILENAME'

If you have multiple versions of a package you can download a specific version with:

curl -O 'https://dl.cloudsmith.io/TOKEN/OWNER/REPOSITORY/raw/versions/VERSION_NO/FILENAME'
curl -u "USERNAME:PASSWORD" -O 'https://dl.cloudsmith.io/basic/OWNER/REPOSITORY/raw/versions/VERSION_NO/FILENAME'
curl -u "USERNAME:API-KEY" -O 'https://dl.cloudsmith.io/basic/OWNER/REPOSITORY/raw/versions/VERSION_NO/FILENAME'
curl -u "token:TOKEN" -O 'https://dl.cloudsmith.io/basic/OWNER/REPOSITORY/raw/versions/VERSION_NO/FILENAME'

Or to get the latest version of the package, replace the version number with 'latest':

curl -O 'https://dl.cloudsmith.io/TOKEN/OWNER/REPOSITORY/raw/versions/latest/FILENAME'
curl -u "USERNAME:PASSWORD" -O 'https://dl.cloudsmith.io/basic/OWNER/REPOSITORY/raw/versions/latest/FILENAME'
curl -u "USERNAME:API-KEY" -O 'https://dl.cloudsmith.io/basic/OWNER/REPOSITORY/raw/versions/latest/FILENAME'
curl -u "token:TOKEN" -O 'https://dl.cloudsmith.io/basic/OWNER/REPOSITORY/raw/versions/latest/FILENAME'

For downloading from a private repository via the Website UI, you can also use the dropdown arrow beside the "Download" button to pick a different way of authenticating for the download.

Upstream Proxying / Caching

Not Supported

Key Signing Support

GPG

Troubleshooting

Please see the Troubleshooting page for further help and information.

Updated 10 days ago


Raw Repository


Cloudsmith provides public & private repositories for Raw files

Suggested Edits are limited on API Reference Pages

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