| '\" t |
| .TH "CARGO\-PUBLISH" "1" |
| .nh |
| .ad l |
| .ss \n[.ss] 0 |
| .SH "NAME" |
| cargo\-publish \[em] Upload a package to the registry |
| .SH "SYNOPSIS" |
| \fBcargo publish\fR [\fIoptions\fR] |
| .SH "DESCRIPTION" |
| This command will create a distributable, compressed \fB\&.crate\fR 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: |
| .sp |
| .RS 4 |
| \h'-04' 1.\h'+01'Performs a few checks, including: |
| .sp |
| .RS 4 |
| \h'-04'\(bu\h'+02'Checks the \fBpackage.publish\fR key in the manifest for restrictions on |
| which registries you are allowed to publish to. |
| .RE |
| .RE |
| .sp |
| .RS 4 |
| \h'-04' 2.\h'+01'Create a \fB\&.crate\fR file by following the steps in \fBcargo\-package\fR(1). |
| .RE |
| .sp |
| .RS 4 |
| \h'-04' 3.\h'+01'Upload the crate to the registry. The server will perform additional |
| checks on the crate. |
| .RE |
| .sp |
| .RS 4 |
| \h'-04' 4.\h'+01'The client will poll waiting for the package to appear in the index, |
| and may timeout. In that case, you will need to check for completion |
| manually. This timeout does not affect the upload. |
| .RE |
| .sp |
| This command requires you to be authenticated with either the \fB\-\-token\fR option |
| or using \fBcargo\-login\fR(1). |
| .sp |
| See \fIthe reference\fR <https://doc.rust\-lang.org/cargo/reference/publishing.html> for more details about |
| packaging and publishing. |
| .SH "OPTIONS" |
| .SS "Publish Options" |
| .sp |
| \fB\-\-dry\-run\fR |
| .RS 4 |
| Perform all checks without uploading. |
| .RE |
| .sp |
| \fB\-\-token\fR \fItoken\fR |
| .RS 4 |
| API token to use when authenticating. This overrides the token stored in |
| the credentials file (which is created by \fBcargo\-login\fR(1)). |
| .sp |
| \fICargo config\fR <https://doc.rust\-lang.org/cargo/reference/config.html> environment variables can be |
| used to override the tokens stored in the credentials file. The token for |
| crates.io may be specified with the \fBCARGO_REGISTRY_TOKEN\fR environment |
| variable. Tokens for other registries may be specified with environment |
| variables of the form \fBCARGO_REGISTRIES_NAME_TOKEN\fR where \fBNAME\fR is the name |
| of the registry in all capital letters. |
| .RE |
| .sp |
| \fB\-\-no\-verify\fR |
| .RS 4 |
| Don\[cq]t verify the contents by building them. |
| .RE |
| .sp |
| \fB\-\-allow\-dirty\fR |
| .RS 4 |
| Allow working directories with uncommitted VCS changes to be packaged. |
| .RE |
| .sp |
| \fB\-\-index\fR \fIindex\fR |
| .RS 4 |
| The URL of the registry index to use. |
| .RE |
| .sp |
| \fB\-\-registry\fR \fIregistry\fR |
| .RS 4 |
| Name of the registry to publish to. Registry names are defined in \fICargo |
| config files\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&. If not specified, and there is a |
| \fI\f(BIpackage.publish\fI\fR <https://doc.rust\-lang.org/cargo/reference/manifest.html#the\-publish\-field> field in |
| \fBCargo.toml\fR with a single registry, then it will publish to that registry. |
| Otherwise it will use the default registry, which is defined by the |
| \fI\f(BIregistry.default\fI\fR <https://doc.rust\-lang.org/cargo/reference/config.html#registrydefault> config key |
| which defaults to \fBcrates\-io\fR\&. |
| .RE |
| .SS "Package Selection" |
| By default, the package in the current working directory is selected. The \fB\-p\fR |
| flag can be used to choose a different package in a workspace. |
| .sp |
| \fB\-p\fR \fIspec\fR, |
| \fB\-\-package\fR \fIspec\fR |
| .RS 4 |
| The package to publish. See \fBcargo\-pkgid\fR(1) for the SPEC |
| format. |
| .RE |
| .SS "Compilation Options" |
| .sp |
| \fB\-\-target\fR \fItriple\fR |
| .RS 4 |
| Publish for the given architecture. The default is the host architecture. The general format of the triple is |
| \fB<arch><sub>\-<vendor>\-<sys>\-<abi>\fR\&. Run \fBrustc \-\-print target\-list\fR for a |
| list of supported targets. This flag may be specified multiple times. |
| .sp |
| This may also be specified with the \fBbuild.target\fR |
| \fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&. |
| .sp |
| Note that specifying this flag makes Cargo run in a different mode where the |
| target artifacts are placed in a separate directory. See the |
| \fIbuild cache\fR <https://doc.rust\-lang.org/cargo/guide/build\-cache.html> documentation for more details. |
| .RE |
| .sp |
| \fB\-\-target\-dir\fR \fIdirectory\fR |
| .RS 4 |
| Directory for all generated artifacts and intermediate files. May also be |
| specified with the \fBCARGO_TARGET_DIR\fR environment variable, or the |
| \fBbuild.target\-dir\fR \fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&. |
| Defaults to \fBtarget\fR in the root of the workspace. |
| .RE |
| .SS "Feature Selection" |
| The feature flags allow you to control which features are enabled. When no |
| feature options are given, the \fBdefault\fR feature is activated for every |
| selected package. |
| .sp |
| See \fIthe features documentation\fR <https://doc.rust\-lang.org/cargo/reference/features.html#command\-line\-feature\-options> |
| for more details. |
| .sp |
| \fB\-F\fR \fIfeatures\fR, |
| \fB\-\-features\fR \fIfeatures\fR |
| .RS 4 |
| Space or comma separated list of features to activate. Features of workspace |
| members may be enabled with \fBpackage\-name/feature\-name\fR syntax. This flag may |
| be specified multiple times, which enables all specified features. |
| .RE |
| .sp |
| \fB\-\-all\-features\fR |
| .RS 4 |
| Activate all available features of all selected packages. |
| .RE |
| .sp |
| \fB\-\-no\-default\-features\fR |
| .RS 4 |
| Do not activate the \fBdefault\fR feature of the selected packages. |
| .RE |
| .SS "Manifest Options" |
| .sp |
| \fB\-\-manifest\-path\fR \fIpath\fR |
| .RS 4 |
| Path to the \fBCargo.toml\fR file. By default, Cargo searches for the |
| \fBCargo.toml\fR file in the current directory or any parent directory. |
| .RE |
| .sp |
| \fB\-\-frozen\fR, |
| \fB\-\-locked\fR |
| .RS 4 |
| Either of these flags requires that the \fBCargo.lock\fR file is |
| up\-to\-date. If the lock file is missing, or it needs to be updated, Cargo will |
| exit with an error. The \fB\-\-frozen\fR flag also prevents Cargo from |
| attempting to access the network to determine if it is out\-of\-date. |
| .sp |
| These may be used in environments where you want to assert that the |
| \fBCargo.lock\fR file is up\-to\-date (such as a CI build) or want to avoid network |
| access. |
| .RE |
| .sp |
| \fB\-\-offline\fR |
| .RS 4 |
| Prevents Cargo from accessing the network for any reason. Without this |
| flag, Cargo will stop with an error if it needs to access the network and |
| the network is not available. With this flag, Cargo will attempt to |
| proceed without the network if possible. |
| .sp |
| Beware that this may result in different dependency resolution than online |
| mode. Cargo will restrict itself to crates that are downloaded locally, even |
| if there might be a newer version as indicated in the local copy of the index. |
| See the \fBcargo\-fetch\fR(1) command to download dependencies before going |
| offline. |
| .sp |
| May also be specified with the \fBnet.offline\fR \fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&. |
| .RE |
| .SS "Miscellaneous Options" |
| .sp |
| \fB\-j\fR \fIN\fR, |
| \fB\-\-jobs\fR \fIN\fR |
| .RS 4 |
| Number of parallel jobs to run. May also be specified with the |
| \fBbuild.jobs\fR \fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&. Defaults to |
| the number of logical CPUs. If negative, it sets the maximum number of |
| parallel jobs to the number of logical CPUs plus provided value. If |
| a string \fBdefault\fR is provided, it sets the value back to defaults. |
| Should not be 0. |
| .RE |
| .sp |
| \fB\-\-keep\-going\fR |
| .RS 4 |
| Build as many crates in the dependency graph as possible, rather than aborting |
| the build on the first one that fails to build. |
| .sp |
| For example if the current package depends on dependencies \fBfails\fR and \fBworks\fR, |
| one of which fails to build, \fBcargo publish \-j1\fR may or may not build the |
| one that succeeds (depending on which one of the two builds Cargo picked to run |
| first), whereas \fBcargo publish \-j1 \-\-keep\-going\fR would definitely run both |
| builds, even if the one run first fails. |
| .RE |
| .SS "Display Options" |
| .sp |
| \fB\-v\fR, |
| \fB\-\-verbose\fR |
| .RS 4 |
| Use verbose output. May be specified twice for \[lq]very verbose\[rq] output which |
| includes extra output such as dependency warnings and build script output. |
| May also be specified with the \fBterm.verbose\fR |
| \fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&. |
| .RE |
| .sp |
| \fB\-q\fR, |
| \fB\-\-quiet\fR |
| .RS 4 |
| Do not print cargo log messages. |
| May also be specified with the \fBterm.quiet\fR |
| \fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&. |
| .RE |
| .sp |
| \fB\-\-color\fR \fIwhen\fR |
| .RS 4 |
| Control when colored output is used. Valid values: |
| .sp |
| .RS 4 |
| \h'-04'\(bu\h'+02'\fBauto\fR (default): Automatically detect if color support is available on the |
| terminal. |
| .RE |
| .sp |
| .RS 4 |
| \h'-04'\(bu\h'+02'\fBalways\fR: Always display colors. |
| .RE |
| .sp |
| .RS 4 |
| \h'-04'\(bu\h'+02'\fBnever\fR: Never display colors. |
| .RE |
| .sp |
| May also be specified with the \fBterm.color\fR |
| \fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&. |
| .RE |
| .SS "Common Options" |
| .sp |
| \fB+\fR\fItoolchain\fR |
| .RS 4 |
| If Cargo has been installed with rustup, and the first argument to \fBcargo\fR |
| begins with \fB+\fR, it will be interpreted as a rustup toolchain name (such |
| as \fB+stable\fR or \fB+nightly\fR). |
| See the \fIrustup documentation\fR <https://rust\-lang.github.io/rustup/overrides.html> |
| for more information about how toolchain overrides work. |
| .RE |
| .sp |
| \fB\-\-config\fR \fIKEY=VALUE\fR or \fIPATH\fR |
| .RS 4 |
| Overrides a Cargo configuration value. The argument should be in TOML syntax of \fBKEY=VALUE\fR, |
| or provided as a path to an extra configuration file. This flag may be specified multiple times. |
| See the \fIcommand\-line overrides section\fR <https://doc.rust\-lang.org/cargo/reference/config.html#command\-line\-overrides> for more information. |
| .RE |
| .sp |
| \fB\-C\fR \fIPATH\fR |
| .RS 4 |
| Changes the current working directory before executing any specified operations. This affects |
| things like where cargo looks by default for the project manifest (\fBCargo.toml\fR), as well as |
| the directories searched for discovering \fB\&.cargo/config.toml\fR, for example. This option must |
| appear before the command name, for example \fBcargo \-C path/to/my\-project build\fR\&. |
| .sp |
| This option is only available on the \fInightly |
| channel\fR <https://doc.rust\-lang.org/book/appendix\-07\-nightly\-rust.html> and |
| requires the \fB\-Z unstable\-options\fR flag to enable (see |
| \fI#10098\fR <https://github.com/rust\-lang/cargo/issues/10098>). |
| .RE |
| .sp |
| \fB\-h\fR, |
| \fB\-\-help\fR |
| .RS 4 |
| Prints help information. |
| .RE |
| .sp |
| \fB\-Z\fR \fIflag\fR |
| .RS 4 |
| Unstable (nightly\-only) flags to Cargo. Run \fBcargo \-Z help\fR for details. |
| .RE |
| .SH "ENVIRONMENT" |
| See \fIthe reference\fR <https://doc.rust\-lang.org/cargo/reference/environment\-variables.html> for |
| details on environment variables that Cargo reads. |
| .SH "EXIT STATUS" |
| .sp |
| .RS 4 |
| \h'-04'\(bu\h'+02'\fB0\fR: Cargo succeeded. |
| .RE |
| .sp |
| .RS 4 |
| \h'-04'\(bu\h'+02'\fB101\fR: Cargo failed to complete. |
| .RE |
| .SH "EXAMPLES" |
| .sp |
| .RS 4 |
| \h'-04' 1.\h'+01'Publish the current package: |
| .sp |
| .RS 4 |
| .nf |
| cargo publish |
| .fi |
| .RE |
| .RE |
| .SH "SEE ALSO" |
| \fBcargo\fR(1), \fBcargo\-package\fR(1), \fBcargo\-login\fR(1) |