cargo-yank man page

cargo-yank — Remove a pushed crate from the index

Synopsis

cargo yank [Options] --vers VERSION [CRATE]

Description

The yank command removes a previously published crate’s version from the server’s index. This command does not delete any data, and the crate will still be available for download via the registry’s download link.

Note that existing crates locked to a yanked version will still be able to download the yanked version to use it. Cargo will, however, not allow any new crates to be locked to any yanked version.

This command requires you to be authenticated with either the --token option or using cargo-login(1).

If the crate name is not specified, it will use the package name from the current directory.

Options

Owner Options

--vers VERSION

The version to yank or un-yank.

--undo

Undo a yank, putting a version back into the index.

--token TOKEN

API token to use when authenticating. This overrides the token stored in the credentials file (which is created by cargo-login(1)).

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 CARGO_REGISTRY_TOKEN environment variable. Tokens for other registries may be specified with environment variables of the form CARGO_REGISTRIES_NAME_TOKEN where NAME is the name of the registry in all capital letters.

--index INDEX

The URL of the registry index to use.

--registry REGISTRY

Name of the registry to use. Registry names are defined in Cargo config files. If not specified, the default registry is used, which is defined by the registry.default config key which defaults to crates-io.

Display Options

-v, --verbose

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 term.verbose config value.

-q, --quiet

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 term.color config value.

Common Options

-h, --help

Prints help information.

-Z FLAG...

Unstable (nightly-only) flags to Cargo. Run cargo -Z help for details.

Environment

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

Exit Status

0

Cargo succeeded.

101

Cargo failed to complete.

Examples

1.

Yank a crate from the index:

cargo yank --vers 1.0.7 foo

See Also

cargo(1), cargo-login(1), cargo-publish(1)

Referenced By

cargo(1).

2019-06-07