Cargo Registry

For more information on Rust, please see:

• Rust: The official website for Rust language
• Cargo: The official documentation for Cargo - the Rust package manager
• Crates Public Registry: The official Rust community’s crate registry

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 pre-configured).

In the following examples:

Upload a Package

Upload via Cargo Publish

Setup

A name and URL for the registry must be added to your .cargo/config file as follows:

Public Repositories

[registries]
REGISTRY_NAME = { index = "https://dl.cloudsmith.io/public/OWNER/REPOSITORY/cargo/index.git" }

Private Repositories

📘

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

The setup method will differ depending on what authentication type you choose to use.

🚧

Entitlement Tokens, User Credentials and API-Keys should be treated as secrets and you should ensure that you do not commit them in configurations files along with source code, or expose them in any logs

[registries]
REGISTRY_NAME = { index = "https://dl.cloudsmith.io/TOKEN/OWNER/REPOSITORY/cargo/index.git" }

[registries]
REGISTRY_NAME = { index = "https://dl.cloudsmith.io/basic/OWNER/REPOSITORY/cargo/index.git" }

If using HTTP basic authentication, you'll need to configure Git with credentials. Git's standard authentication mechanisms are used by Cargo and can be configured in the normal way. For example, you could use git's per-user credential store as follows:

git config --global credential.helper store
echo "https://USERNAME:[email protected]" > ~/.git-credentials

git config --global credential.helper store
echo "https://USERNAME:[email protected]" > ~/.git-credentials

git config --global credential.helper store
echo "https://token:[email protected]" > ~/.git-credentials

For further details or other configuration options, see the Official Git Documentation.

In order to authenticate for publishing via cargo, you can either enter your credentials using the command:

cargo login --registry REGISTRY_NAME

Or, add your credentials to your .cargo/credentials file:

[registries.REGISTRY_NAME]
token = API-KEY

Publish

To publish a crate, you can do so from your project directory using cargo publish as follows:

cargo publish --registry REGISTRY_NAME

If you haven't specified credentials using one of the methods above, you'll be asked to provide them using cargo login.

You can also set the following environment variables:
CARGO_REGISTRIES_<REGISTRY_NAME>_INDEX - instead of setting the registry URL in ~/.cargo/config
CARGO_REGISTRIES_<REGISTRY_NAME>_TOKEN - instead of providing credentials via cargo login or writing them to ~/.cargo/credentials:

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 a cargo crate via the Cloudsmith CLI is:

cloudsmith push cargo OWNER/REPOSITORY PACKAGE_NAME.crate

Example:

cloudsmith push cargo org/repo your-package.crate

Upload via Cloudsmith Website

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

Download a Package

Registry Setup

It is easy to add a Cloudsmith-based Cargo registry.

📘

Cargo Sparse Registry

Cargo Sparse Registries are a new addition to Cargo as of v1.68.0, and are the recommended way to interact with your Cloudsmith Repositories - they offer significant performance advantages over the old Git-based registries, such as reducing the bandwidth used and improving dependency resolution times.

First, the name and config for the registry must be added to your .cargo/config.toml or .cargo/config file as follows:

Cargo >= v1.74 (HTTP Sparse Registry)

[registries.OWNER-REPOSITORY]
index = "sparse+https://cargo.cloudsmith.io/OWNER/REPOSITORY/"
token = "Token API-KEY"
credential-provider = "cargo:token"

[registries.OWNER-REPOSITORY]
index = "sparse+https://cargo.cloudsmith.io/OWNER/REPOSITORY/"
token = "Token TOKEN"
credential-provider = "cargo:token"

Cargo < v1.74 (HTTP Sparse Registry)
If you are using Cargo version < 1.74, the only way to authenticate with a private sparse registry is using Cloudsmith's URL-based authentication.

[registries.OWNER-REPOSITORY]
index = "sparse+https://dl.cloudsmith.io/TOKEN/OWNER/REPOSITORY/cargo/"

Cargo < v1.68 (Legacy Git Registry)

[registries]
OWNER-REPOSITORY = { index = "https://dl.cloudsmith.io/basic/OWNER/REPOSITORY/cargo/index.git" }

[registries]
OWNER-REPOSITORY = { index = "https://dl.cloudsmith.io/TOKEN/OWNER/REPOSITORY/cargo/index.git" }

Registry Authentication

You must configure Git with the proper credentials to clone the registry when using HTTP basic authentication. Git's standard authentication mechanisms are used by Cargo and can be configured normally. For example, you could use git's per-user credential store like so:

git config --global credential.helper store
echo "https://USERNAME:[email protected]" > ~/.git-credentials

When using URL-based authentication, no further configuration is required, you're all set up and ready to go.

Install a Package

Once you have configured a registry using one of the methods described above, a crate can then depend on a crate from your registry by specifying the registry key and a value of the registry's name in that dependency's entry in Cargo.toml:

[package]
name = "PROJECT_NAME"
version = "0.1.0"
[dependencies]
PACKAGE_NAME = { version = "PACKAGE_VERSION", registry = "REGISTRY_NAME" }

You can also install a crate directly by specifying the registry on the command line:

cargo install PACKAGE_NAME --registry REGISTRY_NAME`

Security Scanning

Supported
Please see our Security Scanning documentation for further information.

Upstream Proxying / Caching

Not Supported

📘

When you install a Cargo package, cargo will assume that all dependencies are available in your Cloudsmith repository. You can configure your Cloudsmith repository to fetch any dependencies from crates.io that are not already present. See the repository Main Settings for further information.

Key Signing Support

Not Supported by Format

Troubleshooting

Please see the Troubleshooting page for further help and information.