cargo yank

NAME

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 theserver’s index. This command does not delete any data, and the crate willstill be available for download via the registry’s download link.

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

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

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

OPTIONS

Owner Options

  • —versVERSION

  • The version to yank or un-yank.

  • —undo

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

  • —tokenTOKEN

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

Cargo config environment variables can beused to override the tokens stored in the credentials file. The token forcrates.io may be specified with the CARGO_REGISTRY_TOKEN environmentvariable. Tokens for other registries may be specified with environmentvariables of the form CARGO_REGISTRIES_NAME_TOKEN where NAME is the nameof the registry in all capital letters.

  • —indexINDEX

  • The URL of the registry index to use.

  • —registryREGISTRY

  • 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 theregistry.default config key which defaults to crates-io.

Display Options

  • -v
  • —verbose

  • Use verbose output. May be specified twice for "very verbose" output whichincludes extra output such as dependency warnings and build script output.May also be specified with the term.verboseconfig value.

  • -q

  • —quiet

  • No output printed to stdout.

  • —colorWHEN

  • Control when colored output is used. Valid values:

  • auto (default): Automatically detect if color support is available on theterminal.

  • always: Always display colors.

  • never: Never display colors.

May also be specified with the term.colorconfig value.

Common Options

  • -h
  • —help

  • Prints help information.

  • -ZFLAG…​

  • Unstable (nightly-only) flags to Cargo. Run cargo -Z help fordetails.

ENVIRONMENT

See the reference fordetails on environment variables that Cargo reads.

Exit Status

  • 0

  • Cargo succeeded.

  • 101

  • Cargo failed to complete.

EXAMPLES

  • Yank a crate from the index:
  1. cargo yank --vers 1.0.7 foo

SEE ALSO

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