MAN page from OpenSuSE cargo-1.43.1-lp152.3.5.1.x86_64.rpm

CARGO\-PUBLISH

Section: \ \& (1)
Updated: 2019-09-05
Index

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 <L>This performs thefollowing steps:

1.Performs a few checks, including:

: *Checks the package.publish key in the manifest for restrictions on whichregistries you are allowed to publish to.

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

: 3.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 https://doc.rust-lang.org/cargo/reference/publishing.html <L>the referencefor more details aboutpackaging and publishing.

OPTIONS

Publish Options

--dry-run

: Perform all checks without uploading.

--token TOKEN

: API token to use when authenticating. This overrides the token stored inthe credentials file (which is created by cargo-login(1)).
https://doc.rust-lang.org/cargo/reference/config.html <L>Cargo configenvironment 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

: Doncqt 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

: Name of the registry to use. Registry names are defined in https://doc.rust-lang.org/cargo/reference/config.html <L>Cargo config filesIf not specified, the default registry is used, which is defined by theregistry.default config key which defaults to crates-io.

Compilation Options

--target TRIPLE

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.targethttps://doc.rust-lang.org/cargo/reference/config.html <L>config value

Note that specifying this flag makes Cargo run in a different mode where thetarget artifacts are placed in a separate directory. See thehttps://doc.rust-lang.org/cargo/guide/build-cache.html <L>build cachedocumentation for more details.

--target-dir DIRECTORY

: Directory for all generated artifacts and intermediate files. May also bespecified with the CARGO_TARGET_DIR environment variable, or thebuild.target-dir https://doc.rust-lang.org/cargo/reference/config.html <L>config valueDefaultsto target in the root of the workspace.

Feature Selection

The feature flags allow you to control the enabled features for the "current"package. The "current" package is the package in the current directory, or theone specified in --manifest-path. If running in the root of a virtualworkspace, then the default features are selected for all workspace members,or all features if --all-features is specified.

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

--features FEATURES

: Space or comma separated list of features to activate. These features onlyapply to the current directorycqs package. Features of direct dependenciesmay be enabled with <dep-name>/<feature-name> syntax. This flag may bespecified multiple times, which enables all specified features.

--all-features

: Activate all available features of all selected packages.

--no-default-features

: Do not activate the default feature of the current directorycqspackage.

Manifest Options

--manifest-path PATH

: Path to the Cargo.toml file. By default, Cargo searches for theCargo.toml file in the current directory or any parent directory.

--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 https://doc.rust-lang.org/cargo/reference/config.html <L>config value

Miscellaneous Options

-j N, --jobs N

: Number of parallel jobs to run. May also be specified with thebuild.jobs https://doc.rust-lang.org/cargo/reference/config.html <L>config valueDefaults 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.verbosehttps://doc.rust-lang.org/cargo/reference/config.html <L>config value

-q, --quiet