cargo publish
NAME
cargo-publish - Upload a package to the registry
SYNOPSIS
cargo package [OPTIONS]
DESCRIPTION
This command will create a distributable, compressed .crate file with the
source code of the package in the current directory and upload it to a
registry. The default registry is https://crates.io. This performs the
following steps:
-
Performs a few checks, including:
-
No
[patch]sections are allowed in the manifest. -
Checks the
package.publishkey in the manifest for restrictions on which registries you are allowed to publish to.
-
-
Create a
.cratefile by following the steps in cargo-package(1). -
Upload the crate to the registry. Note that the server will perform additional checks on the crate.
This command requires you to be authenticated with either the --token option
or using cargo-login(1).
See the reference for more details about packaging and publishing.
OPTIONS
Publish Options
- --dry-run
-
Perform all checks without uploading.
- --token TOKEN
-
API token to use when authenticating.
- --no-verify
-
Don’t verify the contents by building them.
- --allow-dirty
-
Allow working directories with uncommitted VCS changes to be packaged.
- --index INDEX
-
The URL of the registry index to use.
- --registry REGISTRY
-
Alternative registry to use.
This option is unstable and available only on the nightly channel and requires the
-Z unstable-optionsflag to enable.
Compilation Options
- --target TRIPLE
-
Publish for the given architecture. The default is the host architecture. The general format of the triple is
<arch><sub>-<vendor>-<sys>-<abi>. Runrustc --print target-listfor a list of supported targets.This may also be specified with the
build.targetconfig value. - --target-dir DIRECTORY
-
Directory for all generated artifacts and intermediate files. May also be specified with the
CARGO_TARGET_DIRenvironment variable, or thebuild.target-dirconfig value. Defaults totargetin the root of the workspace.
Feature Selection
When no feature options are given, the default feature is activated for
every selected package.
- --features FEATURES
-
Space or comma separated list of features to activate. These features only apply to the current directory’s package. Features of direct dependencies may 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
defaultfeature of the current directory’s package.
Manifest Options
- --manifest-path PATH
-
Path to the
Cargo.tomlfile. By default, Cargo searches in the current directory or any parent directory for theCargo.tomlfile. - --frozen
- --locked
-
Either of these flags requires that the
Cargo.lockfile is up-to-date. If the lock file is missing, or it needs to be updated, Cargo will exit with an error. The--frozenflag also prevents Cargo from attempting to access the network to determine if it is out-of-date.These may be used in environments where you want to assert that the
Cargo.lockfile is up-to-date (such as a CI build) or want to avoid network access.
Miscellaneous Options
- -j N
- --jobs N
-
Number of parallel jobs to run. May also be specified with the
build.jobsconfig value. Defaults to the number of CPUs.
Display Options
- -v
- --verbose
-
Use verbose output. May be specified twice for "very verbose" output which includes 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.
- --color WHEN
-
Control when colored output is used. Valid values:
-
auto(default): Automatically detect if color support is available on the terminal. -
always: Always display colors. -
never: Never display colors.
May also be specified with the
term.colorconfig value. -
Common Options
- -h
- --help
-
Prints help information.
- -Z FLAG…
-
Unstable (nightly-only) flags to Cargo. Run
cargo -Z helpfor details.
ENVIRONMENT
See the reference for details on environment variables that Cargo reads.
Exit Status
- 0
-
Cargo succeeded.
- 101
-
Cargo failed to complete.
EXAMPLES
-
Publish the current package:
cargo publish