| '\" t |
| .TH "CARGO\-PACKAGE" "1" |
| .nh |
| .ad l |
| .ss \n[.ss] 0 |
| .SH "NAME" |
| cargo\-package \- Assemble the local package into a distributable tarball |
| .SH "SYNOPSIS" |
| \fBcargo package\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. The resulting file will |
| be stored in the \fBtarget/package\fR directory. This performs the following |
| steps: |
| .sp |
| .RS 4 |
| \h'-04' 1.\h'+01'Load and check the current workspace, performing some basic checks. |
| .sp |
| .RS 4 |
| \h'-04'\(bu\h'+02'Path dependencies are not allowed unless they have a version key. Cargo |
| will ignore the path key for dependencies in published packages. |
| \fBdev\-dependencies\fR do not have this restriction. |
| .RE |
| .RE |
| .sp |
| .RS 4 |
| \h'-04' 2.\h'+01'Create the compressed \fB\&.crate\fR file. |
| .sp |
| .RS 4 |
| \h'-04'\(bu\h'+02'The original \fBCargo.toml\fR file is rewritten and normalized. |
| .RE |
| .sp |
| .RS 4 |
| \h'-04'\(bu\h'+02'\fB[patch]\fR, \fB[replace]\fR, and \fB[workspace]\fR sections are removed from the |
| manifest. |
| .RE |
| .sp |
| .RS 4 |
| \h'-04'\(bu\h'+02'\fBCargo.lock\fR is automatically included if the package contains an |
| executable binary or example target. \fBcargo\-install\fR(1) will use the |
| packaged lock file if the \fB\-\-locked\fR flag is used. |
| .RE |
| .sp |
| .RS 4 |
| \h'-04'\(bu\h'+02'A \fB\&.cargo_vcs_info.json\fR file is included that contains information |
| about the current VCS checkout hash if available (not included with |
| \fB\-\-allow\-dirty\fR). |
| .RE |
| .RE |
| .sp |
| .RS 4 |
| \h'-04' 3.\h'+01'Extract the \fB\&.crate\fR file and build it to verify it can build. |
| .sp |
| .RS 4 |
| \h'-04'\(bu\h'+02'This will rebuild your package from scratch to ensure that it can be |
| built from a pristine state. The \fB\-\-no\-verify\fR flag can be used to skip |
| this step. |
| .RE |
| .RE |
| .sp |
| .RS 4 |
| \h'-04' 4.\h'+01'Check that build scripts did not modify any source files. |
| .RE |
| .sp |
| The list of files included can be controlled with the \fBinclude\fR and \fBexclude\fR |
| fields in the manifest. |
| .sp |
| See \fIthe reference\fR <https://doc.rust\-lang.org/cargo/reference/publishing.html> for more details about |
| packaging and publishing. |
| .SS ".cargo_vcs_info.json format" |
| Will generate a \fB\&.cargo_vcs_info.json\fR in the following format |
| .sp |
| .RS 4 |
| .nf |
| { |
| "git": { |
| "sha1": "aac20b6e7e543e6dd4118b246c77225e3a3a1302" |
| }, |
| "path_in_vcs": "" |
| } |
| .fi |
| .RE |
| .sp |
| \fBpath_in_vcs\fR will be set to a repo\-relative path for packages |
| in subdirectories of the version control repository. |
| .SH "OPTIONS" |
| .SS "Package Options" |
| .sp |
| \fB\-l\fR, |
| \fB\-\-list\fR |
| .RS 4 |
| Print files included in a package without making one. |
| .RE |
| .sp |
| \fB\-\-no\-verify\fR |
| .RS 4 |
| Don't verify the contents by building them. |
| .RE |
| .sp |
| \fB\-\-no\-metadata\fR |
| .RS 4 |
| Ignore warnings about a lack of human\-usable metadata (such as the description |
| or the license). |
| .RE |
| .sp |
| \fB\-\-allow\-dirty\fR |
| .RS 4 |
| Allow working directories with uncommitted VCS changes to be packaged. |
| .RE |
| .SS "Package Selection" |
| By default, when no package selection options are given, the packages selected |
| depend on the selected manifest file (based on the current working directory if |
| \fB\-\-manifest\-path\fR is not given). If the manifest is the root of a workspace then |
| the workspaces default members are selected, otherwise only the package defined |
| by the manifest will be selected. |
| .sp |
| The default members of a workspace can be set explicitly with the |
| \fBworkspace.default\-members\fR key in the root manifest. If this is not set, a |
| virtual workspace will include all workspace members (equivalent to passing |
| \fB\-\-workspace\fR), and a non\-virtual workspace will include only the root crate itself. |
| .sp |
| \fB\-p\fR \fIspec\fR\&..., |
| \fB\-\-package\fR \fIspec\fR\&... |
| .RS 4 |
| Package only the specified packages. See \fBcargo\-pkgid\fR(1) for the |
| SPEC format. This flag may be specified multiple times and supports common Unix |
| glob patterns like \fB*\fR, \fB?\fR and \fB[]\fR\&. However, to avoid your shell accidentally |
| expanding glob patterns before Cargo handles them, you must use single quotes or |
| double quotes around each pattern. |
| .RE |
| .sp |
| \fB\-\-workspace\fR |
| .RS 4 |
| Package all members in the workspace. |
| .RE |
| .sp |
| \fB\-\-exclude\fR \fISPEC\fR\&... |
| .RS 4 |
| Exclude the specified packages. Must be used in conjunction with the |
| \fB\-\-workspace\fR flag. This flag may be specified multiple times and supports |
| common Unix glob patterns like \fB*\fR, \fB?\fR and \fB[]\fR\&. However, to avoid your shell |
| accidentally expanding glob patterns before Cargo handles them, you must use |
| single quotes or double quotes around each pattern. |
| .RE |
| .SS "Compilation Options" |
| .sp |
| \fB\-\-target\fR \fItriple\fR |
| .RS 4 |
| Package 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. |
| .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 CPUs. |
| .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. Unstable, requires |
| \fB\-Zunstable\-options\fR\&. |
| .RE |
| .SS "Display Options" |
| .sp |
| \fB\-v\fR, |
| \fB\-\-verbose\fR |
| .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\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 KEY=VALUE |
| .RS 4 |
| Overrides a Cargo configuration value. |
| .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'Create a compressed \fB\&.crate\fR file of the current package: |
| .sp |
| .RS 4 |
| .nf |
| cargo package |
| .fi |
| .RE |
| .RE |
| .SH "SEE ALSO" |
| \fBcargo\fR(1), \fBcargo\-publish\fR(1) |