| '\" t |
| .\" Title: cargo-publish |
| .\" Author: [see the "AUTHOR(S)" section] |
| .\" Generator: Asciidoctor 2.0.10 |
| .\" Date: 2019-09-05 |
| .\" Manual: \ \& |
| .\" Source: \ \& |
| .\" Language: English |
| .\" |
| .TH "CARGO\-PUBLISH" "1" "2019-09-05" "\ \&" "\ \&" |
| .ie \n(.g .ds Aq \(aq |
| .el .ds Aq ' |
| .ss \n[.ss] 0 |
| .nh |
| .ad l |
| .de URL |
| \fI\\$2\fP <\\$1>\\$3 |
| .. |
| .als MTO URL |
| .if \n[.g] \{\ |
| . mso www.tmac |
| . am URL |
| . ad l |
| . . |
| . am MTO |
| . ad l |
| . . |
| . LINKSTYLE blue R < > |
| .\} |
| .SH "NAME" |
| cargo\-publish \- Upload a package to the registry |
| .SH "SYNOPSIS" |
| .sp |
| \fBcargo publish [\fIOPTIONS\fP]\fP |
| .SH "DESCRIPTION" |
| .sp |
| This command will create a distributable, compressed \fB.crate\fP file with the |
| source code of the package in the current directory and upload it to a |
| registry. The default registry is \c |
| .URL "https://crates.io" "" "." |
| This performs the |
| following steps: |
| .sp |
| .RS 4 |
| .ie n \{\ |
| \h'-04' 1.\h'+01'\c |
| .\} |
| .el \{\ |
| . sp -1 |
| . IP " 1." 4.2 |
| .\} |
| Performs a few checks, including: |
| .sp |
| .RS 4 |
| .ie n \{\ |
| \h'-04'\(bu\h'+03'\c |
| .\} |
| .el \{\ |
| . sp -1 |
| . IP \(bu 2.3 |
| .\} |
| Checks the \fBpackage.publish\fP key in the manifest for restrictions on which |
| registries you are allowed to publish to. |
| .RE |
| .RE |
| .sp |
| .RS 4 |
| .ie n \{\ |
| \h'-04' 2.\h'+01'\c |
| .\} |
| .el \{\ |
| . sp -1 |
| . IP " 2." 4.2 |
| .\} |
| Create a \fB.crate\fP file by following the steps in \fBcargo\-package\fP(1). |
| .RE |
| .sp |
| .RS 4 |
| .ie n \{\ |
| \h'-04' 3.\h'+01'\c |
| .\} |
| .el \{\ |
| . sp -1 |
| . IP " 3." 4.2 |
| .\} |
| Upload the crate to the registry. Note that the server will perform |
| additional checks on the crate. |
| .RE |
| .sp |
| This command requires you to be authenticated with either the \fB\-\-token\fP option |
| or using \fBcargo\-login\fP(1). |
| .sp |
| See \c |
| .URL "https://doc.rust\-lang.org/cargo/reference/publishing.html" "the reference" " " |
| for more details about |
| packaging and publishing. |
| .SH "OPTIONS" |
| .SS "Publish Options" |
| .sp |
| \fB\-\-dry\-run\fP |
| .RS 4 |
| Perform all checks without uploading. |
| .RE |
| .sp |
| \fB\-\-token\fP \fITOKEN\fP |
| .RS 4 |
| API token to use when authenticating. This overrides the token stored in |
| the credentials file (which is created by \fBcargo\-login\fP(1)). |
| .sp |
| .URL "https://doc.rust\-lang.org/cargo/reference/config.html" "Cargo config" " " |
| 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\fP environment |
| variable. Tokens for other registries may be specified with environment |
| variables of the form \fBCARGO_REGISTRIES_NAME_TOKEN\fP where \fBNAME\fP is the name |
| of the registry in all capital letters. |
| .RE |
| .sp |
| \fB\-\-no\-verify\fP |
| .RS 4 |
| Don\(cqt verify the contents by building them. |
| .RE |
| .sp |
| \fB\-\-allow\-dirty\fP |
| .RS 4 |
| Allow working directories with uncommitted VCS changes to be packaged. |
| .RE |
| .sp |
| \fB\-\-index\fP \fIINDEX\fP |
| .RS 4 |
| The URL of the registry index to use. |
| .RE |
| .sp |
| \fB\-\-registry\fP \fIREGISTRY\fP |
| .RS 4 |
| Name of the registry to use. Registry names are defined in \c |
| .URL "https://doc.rust\-lang.org/cargo/reference/config.html" "Cargo config files" "." |
| If not specified, the default registry is used, which is defined by the |
| \fBregistry.default\fP config key which defaults to \fBcrates\-io\fP. |
| .RE |
| .SS "Compilation Options" |
| .sp |
| \fB\-\-target\fP \fITRIPLE\fP |
| .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>\fP. Run \fBrustc \-\-print target\-list\fP for a |
| list of supported targets. |
| .sp |
| This may also be specified with the \fBbuild.target\fP |
| .URL "https://doc.rust\-lang.org/cargo/reference/config.html" "config value" "." |
| .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 |
| .URL "https://doc.rust\-lang.org/cargo/guide/build\-cache.html" "build cache" " " |
| documentation for more details. |
| .RE |
| .sp |
| \fB\-\-target\-dir\fP \fIDIRECTORY\fP |
| .RS 4 |
| Directory for all generated artifacts and intermediate files. May also be |
| specified with the \fBCARGO_TARGET_DIR\fP environment variable, or the |
| \fBbuild.target\-dir\fP \c |
| .URL "https://doc.rust\-lang.org/cargo/reference/config.html" "config value" "." |
| Defaults |
| to \fBtarget\fP in the root of the workspace. |
| .RE |
| .SS "Feature Selection" |
| .sp |
| When no feature options are given, the \fBdefault\fP feature is activated for |
| every selected package. |
| .sp |
| \fB\-\-features\fP \fIFEATURES\fP |
| .RS 4 |
| Space or comma separated list of features to activate. These features only |
| apply to the current directory\(cqs package. Features of direct dependencies |
| may be enabled with \fB<dep\-name>/<feature\-name>\fP syntax. This flag may be |
| specified multiple times, which enables all specified features. |
| .RE |
| .sp |
| \fB\-\-all\-features\fP |
| .RS 4 |
| Activate all available features of all selected packages. |
| .RE |
| .sp |
| \fB\-\-no\-default\-features\fP |
| .RS 4 |
| Do not activate the \fBdefault\fP feature of the current directory\(cqs |
| package. |
| .RE |
| .SS "Manifest Options" |
| .sp |
| \fB\-\-manifest\-path\fP \fIPATH\fP |
| .RS 4 |
| Path to the \fBCargo.toml\fP file. By default, Cargo searches for the |
| \fBCargo.toml\fP file in the current directory or any parent directory. |
| .RE |
| .sp |
| \fB\-\-frozen\fP, \fB\-\-locked\fP |
| .RS 4 |
| Either of these flags requires that the \fBCargo.lock\fP 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\fP 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\fP file is up\-to\-date (such as a CI build) or want to avoid network |
| access. |
| .RE |
| .sp |
| \fB\-\-offline\fP |
| .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\fP(1) command to download dependencies before going |
| offline. |
| .sp |
| May also be specified with the \fBnet.offline\fP \c |
| .URL "https://doc.rust\-lang.org/cargo/reference/config.html" "config value" "." |
| .RE |
| .SS "Miscellaneous Options" |
| .sp |
| \fB\-j\fP \fIN\fP, \fB\-\-jobs\fP \fIN\fP |
| .RS 4 |
| Number of parallel jobs to run. May also be specified with the |
| \fBbuild.jobs\fP \c |
| .URL "https://doc.rust\-lang.org/cargo/reference/config.html" "config value" "." |
| Defaults to |
| the number of CPUs. |
| .RE |
| .SS "Display Options" |
| .sp |
| \fB\-v\fP, \fB\-\-verbose\fP |
| .RS 4 |
| 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 \fBterm.verbose\fP |
| .URL "https://doc.rust\-lang.org/cargo/reference/config.html" "config value" "." |
| .RE |
| .sp |
| \fB\-q\fP, \fB\-\-quiet\fP |
| .RS 4 |
| No output printed to stdout. |
| .RE |
| .sp |
| \fB\-\-color\fP \fIWHEN\fP |
| .RS 4 |
| Control when colored output is used. Valid values: |
| .sp |
| .RS 4 |
| .ie n \{\ |
| \h'-04'\(bu\h'+03'\c |
| .\} |
| .el \{\ |
| . sp -1 |
| . IP \(bu 2.3 |
| .\} |
| \fBauto\fP (default): Automatically detect if color support is available on the |
| terminal. |
| .RE |
| .sp |
| .RS 4 |
| .ie n \{\ |
| \h'-04'\(bu\h'+03'\c |
| .\} |
| .el \{\ |
| . sp -1 |
| . IP \(bu 2.3 |
| .\} |
| \fBalways\fP: Always display colors. |
| .RE |
| .sp |
| .RS 4 |
| .ie n \{\ |
| \h'-04'\(bu\h'+03'\c |
| .\} |
| .el \{\ |
| . sp -1 |
| . IP \(bu 2.3 |
| .\} |
| \fBnever\fP: Never display colors. |
| .RE |
| .sp |
| May also be specified with the \fBterm.color\fP |
| .URL "https://doc.rust\-lang.org/cargo/reference/config.html" "config value" "." |
| .RE |
| .SS "Common Options" |
| .sp |
| \fB\-h\fP, \fB\-\-help\fP |
| .RS 4 |
| Prints help information. |
| .RE |
| .sp |
| \fB\-Z\fP \fIFLAG\fP... |
| .RS 4 |
| Unstable (nightly\-only) flags to Cargo. Run \fBcargo \-Z help\fP for |
| details. |
| .RE |
| .SH "ENVIRONMENT" |
| .sp |
| See \c |
| .URL "https://doc.rust\-lang.org/cargo/reference/environment\-variables.html" "the reference" " " |
| for |
| details on environment variables that Cargo reads. |
| .SH "EXIT STATUS" |
| .sp |
| 0 |
| .RS 4 |
| Cargo succeeded. |
| .RE |
| .sp |
| 101 |
| .RS 4 |
| Cargo failed to complete. |
| .RE |
| .SH "EXAMPLES" |
| .sp |
| .RS 4 |
| .ie n \{\ |
| \h'-04' 1.\h'+01'\c |
| .\} |
| .el \{\ |
| . sp -1 |
| . IP " 1." 4.2 |
| .\} |
| Publish the current package: |
| .sp |
| .if n .RS 4 |
| .nf |
| cargo publish |
| .fi |
| .if n .RE |
| .RE |
| .SH "SEE ALSO" |
| .sp |
| \fBcargo\fP(1), \fBcargo\-package\fP(1), \fBcargo\-login\fP(1) |