cargo-yank(1)

1CARGO-YANK(1)                                                    CARGO-YANK(1)
2
3
4

NAME

6       cargo-yank - Remove a pushed crate from the index
7

SYNOPSIS

9       cargo yank [OPTIONS] --vers VERSION [CRATE]
10

DESCRIPTION

12       The yank command removes a previously published crate’s version from
13       the server’s index. This command does not delete any data, and the
14       crate will still be available for download via the registry’s download
15       link.
16
17       Note that existing crates locked to a yanked version will still be able
18       to download the yanked version to use it. Cargo will, however, not
19       allow any new crates to be locked to any yanked version.
20
21       This command requires you to be authenticated with either the --token
22       option or using cargo-login(1).
23
24       If the crate name is not specified, it will use the package name from
25       the current directory.
26

OPTIONS

28   Owner Options
29       --vers VERSION
30           The version to yank or un-yank.
31
32       --undo
33           Undo a yank, putting a version back into the index.
34
35       --token TOKEN
36           API token to use when authenticating. This overrides the token
37           stored in the credentials file (which is created by
38           cargo-login(1)).
39
40           Cargo config
41           <https://doc.rust-lang.org/cargo/reference/config.html> environment
42           variables can be used to override the tokens stored in the
43           credentials file. The token for crates.io may be specified with the
44           CARGO_REGISTRY_TOKEN environment variable. Tokens for other
45           registries may be specified with environment variables of the form
46           CARGO_REGISTRIES_NAME_TOKEN where NAME is the name of the registry
47           in all capital letters.
48
49       --index INDEX
50           The URL of the registry index to use.
51
52       --registry REGISTRY
53           Name of the registry to use. Registry names are defined in Cargo
54           config files
55           <https://doc.rust-lang.org/cargo/reference/config.html>. If not
56           specified, the default registry is used, which is defined by the
57           registry.default config key which defaults to crates-io.
58
59   Display Options
60       -v, --verbose
61           Use verbose output. May be specified twice for "very verbose"
62           output which includes extra output such as dependency warnings and
63           build script output. May also be specified with the term.verbose
64           config value
65           <https://doc.rust-lang.org/cargo/reference/config.html>.
66
67       -q, --quiet
68           No output printed to stdout.
69
70       --color WHEN
71           Control when colored output is used. Valid values:
72
73           ·   auto (default): Automatically detect if color support is
74               available on the terminal.
75
76           ·   always: Always display colors.
77
78           ·   never: Never display colors.
79
80           May also be specified with the term.color config value
81           <https://doc.rust-lang.org/cargo/reference/config.html>.
82
83   Common Options
84       -h, --help
85           Prints help information.
86
87       -Z FLAG...
88           Unstable (nightly-only) flags to Cargo. Run cargo -Z help for
89           details.
90

ENVIRONMENT

92       See the reference
93       <https://doc.rust-lang.org/cargo/reference/environment-variables.html>
94       for details on environment variables that Cargo reads.
95

EXIT STATUS

97       0
98           Cargo succeeded.
99
100       101
101           Cargo failed to complete.
102

EXAMPLES

104        1. Yank a crate from the index:
105
106               cargo yank --vers 1.0.7 foo
107