cargo publish

NAME

cargo-publish - Upload a package to the registry

SYNOPSIS

cargo publish [OPTIONS]

DESCRIPTION

This command will create a distributable, compressed .crate file with thesource code of the package in the current directory and upload it to aregistry. The default registry is https://crates.io. This performs thefollowing steps:

  • Performs a few checks, including:
  • Checks the package.publish key in the manifest for restrictions on whichregistries you are allowed to publish to.

  • Create a .crate file by following the steps in cargo-package(1).

  • Upload the crate to the registry. Note that the server will performadditional checks on the crate.

This command requires you to be authenticated with either the —token optionor using cargo-login(1).

See the reference for more details aboutpackaging and publishing.

OPTIONS

Publish Options

  • —dry-run

  • Perform all checks without uploading.

  • —tokenTOKEN

  • API token to use when authenticating. This overrides the token stored inthe credentials file (which is created by cargo-login(1)).

Cargo config environment variables can beused to override the tokens stored in the credentials file. The token forcrates.io may be specified with the CARGO_REGISTRY_TOKEN environmentvariable. Tokens for other registries may be specified with environmentvariables of the form CARGO_REGISTRIES_NAME_TOKEN where NAME is the nameof the registry in all capital letters.

  • —no-verify

  • Don’t verify the contents by building them.

  • —allow-dirty

  • Allow working directories with uncommitted VCS changes to be packaged.

  • —indexINDEX

  • The URL of the registry index to use.

  • —registryREGISTRY

  • Name of the registry to use. Registry names are defined in Cargo config files.If not specified, the default registry is used, which is defined by theregistry.default config key which defaults to crates-io.

Compilation Options

  • —targetTRIPLE
  • Publish for the given architecture. The default is the hostarchitecture. The general format of the triple is<arch><sub>-<vendor>-<sys>-<abi>. Run rustc —print target-list for alist of supported targets.

This may also be specified with the build.targetconfig value.

  • —target-dirDIRECTORY
  • Directory for all generated artifacts and intermediate files. May also bespecified with the CARGO_TARGET_DIR environment variable, or thebuild.target-dir config value. Defaultsto target in the root of the workspace.

Feature Selection

When no feature options are given, the default feature is activated forevery selected package.

  • —featuresFEATURES

  • Space or comma separated list of features to activate. These features onlyapply to the current directory’s package. Features of direct dependenciesmay be enabled with <dep-name>/<feature-name> syntax.

  • —all-features

  • Activate all available features of all selected packages.

  • —no-default-features

  • Do not activate the default feature of the current directory’spackage.

Manifest Options

  • —manifest-pathPATH

  • Path to the Cargo.toml file. By default, Cargo searches in the currentdirectory or any parent directory for the Cargo.toml file.

  • —frozen

  • —locked
  • Either of these flags requires that the Cargo.lock file isup-to-date. If the lock file is missing, or it needs to be updated, Cargo willexit with an error. The —frozen flag also prevents Cargo fromattempting to access the network to determine if it is out-of-date.

These may be used in environments where you want to assert that theCargo.lock file is up-to-date (such as a CI build) or want to avoid networkaccess.

  • —offline
  • Prevents Cargo from accessing the network for any reason. Without thisflag, Cargo will stop with an error if it needs to access the network andthe network is not available. With this flag, Cargo will attempt toproceed without the network if possible.

Beware that this may result in different dependency resolution than onlinemode. Cargo will restrict itself to crates that are downloaded locally, evenif there might be a newer version as indicated in the local copy of the index.See the cargo-fetch(1) command to download dependencies before goingoffline.

May also be specified with the net.offline config value.

Miscellaneous Options

  • -jN
  • —jobsN
  • Number of parallel jobs to run. May also be specified with thebuild.jobs config value. Defaults tothe number of CPUs.

Display Options

  • -v
  • —verbose

  • Use verbose output. May be specified twice for "very verbose" output whichincludes extra output such as dependency warnings and build script output.May also be specified with the term.verboseconfig value.

  • -q

  • —quiet

  • No output printed to stdout.

  • —colorWHEN

  • Control when colored output is used. Valid values:

  • auto (default): Automatically detect if color support is available on theterminal.

  • always: Always display colors.

  • never: Never display colors.

May also be specified with the term.colorconfig value.

Common Options

  • -h
  • —help

  • Prints help information.

  • -ZFLAG…​

  • Unstable (nightly-only) flags to Cargo. Run cargo -Z help fordetails.

ENVIRONMENT

See the reference fordetails on environment variables that Cargo reads.

Exit Status

  • 0

  • Cargo succeeded.

  • 101

  • Cargo failed to complete.

EXAMPLES

  • Publish the current package:
  1. cargo publish

SEE ALSO

cargo(1), cargo-package(1), cargo-login(1)