cargo-publish(1)

NAME

cargo-publish --- Upload a package to the registry

SYNOPSIS

cargo publish [options]

DESCRIPTION

This command will create a distributable, compressed .crate 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:

1. Performs a few checks, including:
   • Checks the package.publish key in the manifest for restrictions on which registries 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. The server will perform additional checks on the crate.
4. 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.

This command requires you to be authenticated using cargo-login(1) or environment variables of the registry.token and registries.<name>.token config fields.

See the reference for more details about packaging and publishing.

OPTIONS

Publish Options

<dl> <dt class="option-term" id="option-cargo-publish---dry-run"><a class="option-anchor" href="#option-cargo-publish---dry-run"><code>--dry-run</code></a></dt> <dd class="option-desc"><p>Perform all checks without uploading.</p> </dd> <dt class="option-term" id="option-cargo-publish---no-verify"><a class="option-anchor" href="#option-cargo-publish---no-verify"><code>--no-verify</code></a></dt> <dd class="option-desc"><p>Don’t verify the contents by building them.</p> </dd> <dt class="option-term" id="option-cargo-publish---allow-dirty"><a class="option-anchor" href="#option-cargo-publish---allow-dirty"><code>--allow-dirty</code></a></dt> <dd class="option-desc"><p>Allow working directories with uncommitted VCS changes to be packaged.</p> </dd> <dt class="option-term" id="option-cargo-publish---index"><a class="option-anchor" href="#option-cargo-publish---index"><code>--index</code> <em>index</em></a></dt> <dd class="option-desc"><p>The URL of the registry index to use.</p> </dd> <dt class="option-term" id="option-cargo-publish---registry"><a class="option-anchor" href="#option-cargo-publish---registry"><code>--registry</code> <em>registry</em></a></dt> <dd class="option-desc"><p>Name of the registry to publish to. Registry names are defined in <a href="../reference/config.html">Cargo config files</a>. If not specified, and there is a <a href="../reference/manifest.html#the-publish-field"><code>package.publish</code></a> field in <code>Cargo.toml</code> with a single registry, then it will publish to that registry. Otherwise it will use the default registry, which is defined by the <a href="../reference/config.html#registrydefault"><code>registry.default</code></a> config key which defaults to <code>crates-io</code>.</p> </dd> </dl>

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 --manifest-path 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.

The default members of a workspace can be set explicitly with the workspace.default-members key in the root manifest. If this is not set, a virtual workspace will include all workspace members (equivalent to passing --workspace), and a non-virtual workspace will include only the root crate itself.

<dl> <dt class="option-term" id="option-cargo-publish--p"><a class="option-anchor" href="#option-cargo-publish--p"><code>-p</code> <em>spec</em>…</a></dt> <dt class="option-term" id="option-cargo-publish---package"><a class="option-anchor" href="#option-cargo-publish---package"><code>--package</code> <em>spec</em>…</a></dt> <dd class="option-desc"><p>Publish only the specified packages. See <a href="cargo-pkgid.html">cargo-pkgid(1)</a> for the SPEC format. This flag may be specified multiple times and supports common Unix glob patterns like <code>*</code>, <code>?</code> and <code>[]</code>. However, to avoid your shell accidentally expanding glob patterns before Cargo handles them, you must use single quotes or double quotes around each pattern.</p> </dd> <dt class="option-term" id="option-cargo-publish---workspace"><a class="option-anchor" href="#option-cargo-publish---workspace"><code>--workspace</code></a></dt> <dd class="option-desc"><p>Publish all members in the workspace.</p> </dd> <dt class="option-term" id="option-cargo-publish---all"><a class="option-anchor" href="#option-cargo-publish---all"><code>--all</code></a></dt> <dd class="option-desc"><p>Deprecated alias for <code>--workspace</code>.</p> </dd> <dt class="option-term" id="option-cargo-publish---exclude"><a class="option-anchor" href="#option-cargo-publish---exclude"><code>--exclude</code> <em>SPEC</em>…</a></dt> <dd class="option-desc"><p>Exclude the specified packages. Must be used in conjunction with the <code>--workspace</code> flag. This flag may be specified multiple times and supports common Unix glob patterns like <code>*</code>, <code>?</code> and <code>[]</code>. However, to avoid your shell accidentally expanding glob patterns before Cargo handles them, you must use single quotes or double quotes around each pattern.</p> </dd> </dl>

Compilation Options

<dl> <dt class="option-term" id="option-cargo-publish---target"><a class="option-anchor" href="#option-cargo-publish---target"><code>--target</code> <em>triple</em></a></dt> <dd class="option-desc"><p>Publish for the specified target architecture. Flag may be specified multiple times. The default is the host architecture. The general format of the triple is <code>&lt;arch&gt;&lt;sub&gt;-&lt;vendor&gt;-&lt;sys&gt;-&lt;abi&gt;</code>.</p> <p>Possible values:</p> <ul> <li>Any supported target in <code>rustc --print target-list</code>.</li> <li><code>"host-tuple"</code>, which will internally be substituted by the host’s target. This can be particularly useful if you’re cross-compiling some crates, and don’t want to specify your host’s machine as a target (for instance, an <code>xtask</code> in a shared project that may be worked on by many hosts).</li> <li>A path to a custom target specification. See <a href="../../rustc/targets/custom.html#custom-target-lookup-path">Custom Target Lookup Path</a> for more information.</li> </ul> <p>This may also be specified with the <code>build.target</code> <a href="../reference/config.html">config value</a>.</p> <p>Note that specifying this flag makes Cargo run in a different mode where the target artifacts are placed in a separate directory. See the <a href="../reference/build-cache.html">build cache</a> documentation for more details.</p> </dd> <dt class="option-term" id="option-cargo-publish---target-dir"><a class="option-anchor" href="#option-cargo-publish---target-dir"><code>--target-dir</code> <em>directory</em></a></dt> <dd class="option-desc"><p>Directory for all generated artifacts and intermediate files. May also be specified with the <code>CARGO_TARGET_DIR</code> environment variable, or the <code>build.target-dir</code> <a href="../reference/config.html">config value</a>. Defaults to <code>target</code> in the root of the workspace.</p> </dd> </dl>

Feature Selection

The feature flags allow you to control which features are enabled. When no feature options are given, the default feature is activated for every selected package.

See the features documentation for more details.

<dl> <dt class="option-term" id="option-cargo-publish--F"><a class="option-anchor" href="#option-cargo-publish--F"><code>-F</code> <em>features</em></a></dt> <dt class="option-term" id="option-cargo-publish---features"><a class="option-anchor" href="#option-cargo-publish---features"><code>--features</code> <em>features</em></a></dt> <dd class="option-desc"><p>Space or comma separated list of features to activate. Features of workspace members may be enabled with <code>package-name/feature-name</code> syntax. This flag may be specified multiple times, which enables all specified features.</p> </dd> <dt class="option-term" id="option-cargo-publish---all-features"><a class="option-anchor" href="#option-cargo-publish---all-features"><code>--all-features</code></a></dt> <dd class="option-desc"><p>Activate all available features of all selected packages.</p> </dd> <dt class="option-term" id="option-cargo-publish---no-default-features"><a class="option-anchor" href="#option-cargo-publish---no-default-features"><code>--no-default-features</code></a></dt> <dd class="option-desc"><p>Do not activate the <code>default</code> feature of the selected packages.</p> </dd> </dl>

Manifest Options

<dl> <dt class="option-term" id="option-cargo-publish---manifest-path"><a class="option-anchor" href="#option-cargo-publish---manifest-path"><code>--manifest-path</code> <em>path</em></a></dt> <dd class="option-desc"><p>Path to the <code>Cargo.toml</code> file. By default, Cargo searches for the <code>Cargo.toml</code> file in the current directory or any parent directory.</p> </dd> <dt class="option-term" id="option-cargo-publish---locked"><a class="option-anchor" href="#option-cargo-publish---locked"><code>--locked</code></a></dt> <dd class="option-desc"><p>Asserts that the exact same dependencies and versions are used as when the existing <code>Cargo.lock</code> file was originally generated. Cargo will exit with an error when either of the following scenarios arises:</p> <ul> <li>The lock file is missing.</li> <li>Cargo attempted to change the lock file due to a different dependency resolution.</li> </ul> <p>It may be used in environments where deterministic builds are desired, such as in CI pipelines.</p> </dd> <dt class="option-term" id="option-cargo-publish---offline"><a class="option-anchor" href="#option-cargo-publish---offline"><code>--offline</code></a></dt> <dd class="option-desc"><p>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.</p> <p>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 <a href="cargo-fetch.html">cargo-fetch(1)</a> command to download dependencies before going offline.</p> <p>May also be specified with the <code>net.offline</code> <a href="../reference/config.html">config value</a>.</p> </dd> <dt class="option-term" id="option-cargo-publish---frozen"><a class="option-anchor" href="#option-cargo-publish---frozen"><code>--frozen</code></a></dt> <dd class="option-desc"><p>Equivalent to specifying both <code>--locked</code> and <code>--offline</code>.</p> </dd> </dl>

Miscellaneous Options

<dl> <dt class="option-term" id="option-cargo-publish--j"><a class="option-anchor" href="#option-cargo-publish--j"><code>-j</code> <em>N</em></a></dt> <dt class="option-term" id="option-cargo-publish---jobs"><a class="option-anchor" href="#option-cargo-publish---jobs"><code>--jobs</code> <em>N</em></a></dt> <dd class="option-desc"><p>Number of parallel jobs to run. May also be specified with the <code>build.jobs</code> <a href="../reference/config.html">config value</a>. 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 <code>default</code> is provided, it sets the value back to defaults. Should not be 0.</p> </dd> <dt class="option-term" id="option-cargo-publish---keep-going"><a class="option-anchor" href="#option-cargo-publish---keep-going"><code>--keep-going</code></a></dt> <dd class="option-desc"><p>Build as many crates in the dependency graph as possible, rather than aborting the build on the first one that fails to build.</p> <p>For example if the current package depends on dependencies <code>fails</code> and <code>works</code>, one of which fails to build, <code>cargo publish -j1</code> may or may not build the one that succeeds (depending on which one of the two builds Cargo picked to run first), whereas <code>cargo publish -j1 --keep-going</code> would definitely run both builds, even if the one run first fails.</p> </dd> </dl>

Display Options

<dl> <dt class="option-term" id="option-cargo-publish--v"><a class="option-anchor" href="#option-cargo-publish--v"><code>-v</code></a></dt> <dt class="option-term" id="option-cargo-publish---verbose"><a class="option-anchor" href="#option-cargo-publish---verbose"><code>--verbose</code></a></dt> <dd class="option-desc"><p>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 <code>term.verbose</code> <a href="../reference/config.html">config value</a>.</p> </dd> <dt class="option-term" id="option-cargo-publish--q"><a class="option-anchor" href="#option-cargo-publish--q"><code>-q</code></a></dt> <dt class="option-term" id="option-cargo-publish---quiet"><a class="option-anchor" href="#option-cargo-publish---quiet"><code>--quiet</code></a></dt> <dd class="option-desc"><p>Do not print cargo log messages. May also be specified with the <code>term.quiet</code> <a href="../reference/config.html">config value</a>.</p> </dd> <dt class="option-term" id="option-cargo-publish---color"><a class="option-anchor" href="#option-cargo-publish---color"><code>--color</code> <em>when</em></a></dt> <dd class="option-desc"><p>Control when colored output is used. Valid values:</p> <ul> <li><code>auto</code> (default): Automatically detect if color support is available on the terminal.</li> <li><code>always</code>: Always display colors.</li> <li><code>never</code>: Never display colors.</li> </ul> <p>May also be specified with the <code>term.color</code> <a href="../reference/config.html">config value</a>.</p> </dd> </dl>

Common Options

<dl> <dt class="option-term" id="option-cargo-publish-+toolchain"><a class="option-anchor" href="#option-cargo-publish-+toolchain"><code>+</code><em>toolchain</em></a></dt> <dd class="option-desc"><p>If Cargo has been installed with rustup, and the first argument to <code>cargo</code> begins with <code>+</code>, it will be interpreted as a rustup toolchain name (such as <code>+stable</code> or <code>+nightly</code>). See the <a href="https://rust-lang.github.io/rustup/overrides.html">rustup documentation</a> for more information about how toolchain overrides work.</p> </dd> <dt class="option-term" id="option-cargo-publish---config"><a class="option-anchor" href="#option-cargo-publish---config"><code>--config</code> <em>KEY=VALUE</em> or <em>PATH</em></a></dt> <dd class="option-desc"><p>Overrides a Cargo configuration value. The argument should be in TOML syntax of <code>KEY=VALUE</code>, or provided as a path to an extra configuration file. This flag may be specified multiple times. See the <a href="../reference/config.html#command-line-overrides">command-line overrides section</a> for more information.</p> </dd> <dt class="option-term" id="option-cargo-publish--C"><a class="option-anchor" href="#option-cargo-publish--C"><code>-C</code> <em>PATH</em></a></dt> <dd class="option-desc"><p>Changes the current working directory before executing any specified operations. This affects things like where cargo looks by default for the project manifest (<code>Cargo.toml</code>), as well as the directories searched for discovering <code>.cargo/config.toml</code>, for example. This option must appear before the command name, for example <code>cargo -C path/to/my-project build</code>.</p> <p>This option is only available on the <a href="https://doc.rust-lang.org/book/appendix-07-nightly-rust.html">nightly channel</a> and requires the <code>-Z unstable-options</code> flag to enable (see <a href="https://github.com/rust-lang/cargo/issues/10098">#10098</a>).</p> </dd> <dt class="option-term" id="option-cargo-publish--h"><a class="option-anchor" href="#option-cargo-publish--h"><code>-h</code></a></dt> <dt class="option-term" id="option-cargo-publish---help"><a class="option-anchor" href="#option-cargo-publish---help"><code>--help</code></a></dt> <dd class="option-desc"><p>Prints help information.</p> </dd> <dt class="option-term" id="option-cargo-publish--Z"><a class="option-anchor" href="#option-cargo-publish--Z"><code>-Z</code> <em>flag</em></a></dt> <dd class="option-desc"><p>Unstable (nightly-only) flags to Cargo. Run <code>cargo -Z help</code> for details.</p> </dd> </dl>

ENVIRONMENT

See the reference for details on environment variables that Cargo reads.

EXIT STATUS

• 0: Cargo succeeded.
• 101: Cargo failed to complete.

EXAMPLES

1. Publish the current package:

   Copy

   cargo publish
   

SEE ALSO

cargo(1), cargo-package(1), cargo-login(1)