How to Publish a Crate to crates.io

Cargo
2026-04-17T16:39:40+00:00
To publish a crate to crates.io, you must first register an account, log in via the `cargo` CLI, and then run `cargo publish` from your crate's root directory.

To publish a crate to crates.io, you must first register an account, log in via the cargo CLI, and then run cargo publish from your crate's root directory. Before the first publish, ensure your Cargo.toml metadata (like description, license, and repository) is complete, as the registry will reject crates missing these fields.

Start by creating an account at crates.io and generating an API token in your profile settings. Use this token to log in to your local environment:

cargo login <YOUR_API_TOKEN>

Once authenticated, navigate to your crate's directory and execute the publish command. It is highly recommended to run cargo package first to verify that your build artifacts and included files are correct without actually uploading anything:

# Verify the package locally
cargo package

# Publish to crates.io
cargo publish

If cargo package succeeds, cargo publish will upload the tarball to the registry. If you receive an error about missing metadata, update your Cargo.toml with the required fields:

[package]
name = "my-awesome-crate"
version = "0.1.0"
edition = "2021"
description = "A brief description of what the crate does"
license = "MIT"
repository = "https://github.com/username/my-awesome-crate"

Note that publishing is idempotent for the same version; you cannot overwrite a published version. If you need to fix a bug in a released version, you must bump the version number (e.g., from 0.1.0 to 0.1.1) and publish again. If you accidentally publish a version with a typo in the name or a critical error, you can yank the version using cargo yank --vers 0.1.0, which marks it as unavailable for new downloads but does not remove it from the registry.

Ensure your crate follows the Rust API guidelines and that your Cargo.toml does not contain private dependencies or paths that won't resolve for other users. The cargo package step is crucial here because it simulates the exact environment the registry will use to build your crate, catching issues like missing files in .gitignore or incorrect include/exclude patterns before you hit the network.