cargo-package - Assemble the local package into a distributable tarball
cargo package [OPTIONS]
This command will create a distributable, compressed
.crate file with the
source code of the package in the current directory. The resulting file will
be stored in the
target/package directory. This performs the following
Load and check the current workspace, performing some basic checks.
Path dependencies are not allowed unless they have a version key. Cargo will ignore the path key for dependencies in published packages.
dev-dependenciesdo not have this restriction.
Create the compressed
Cargo.tomlfile is rewritten and normalized.
[workspace]sections are removed from the manifest.
Cargo.lockis automatically included if the package contains an executable binary or example target. cargo-install(1) will use the packaged lock file if the
--lockedflag is used.
.cargo_vcs_info.jsonfile is included that contains information about the current VCS checkout hash if available (not included with
.cratefile and build it to verify it can build.
This will rebuild your package from scratch to ensure that it can be built from a pristine state. The
--no-verifyflag can be used to skip this step.
Check that build scripts did not modify any source files.
The list of files included can be controlled with the
fields in the manifest.
See the reference for more details about packaging and publishing.
Print files included in a package without making one.
Don’t verify the contents by building them.
Ignore warnings about a lack of human-usable metadata (such as the description or the license).
Allow working directories with uncommitted VCS changes to be packaged.
- --target TRIPLE
Package for the given architecture. The default is the host architecture. The general format of the triple is
rustc --print target-listfor a list of supported targets.
This may also be specified with the
Note that specifying this flag makes Cargo run in a different mode where the target artifacts are placed in a separate directory. See the build cache documentation for more details.
- --target-dir DIRECTORY
Directory for all generated artifacts and intermediate files. May also be specified with the
CARGO_TARGET_DIRenvironment variable, or the
build.target-dirconfig value. Defaults to
targetin the root of the workspace.
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 the
one specified in
--manifest-path. If running in the root of a virtual
workspace, 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 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. This flag may be specified multiple times, which enables all specified features.
Activate all available features of all selected packages.
Do not activate the
defaultfeature of the current directory’s package.
- --manifest-path PATH
Path to the
Cargo.tomlfile. By default, Cargo searches for the
Cargo.tomlfile in the current directory or any parent directory.
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.
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.
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 cargo-fetch(1) command to download dependencies before going offline.
May also be specified with the
- -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.
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
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
Prints help information.
- -Z FLAG…
Unstable (nightly-only) flags to Cargo. Run
cargo -Z helpfor details.
See the reference for details on environment variables that Cargo reads.
Cargo failed to complete.
Create a compressed
.cratefile of the current package: