forked from rust-lang/cargo
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathcargo-owner.html
220 lines (220 loc) · 6.62 KB
/
cargo-owner.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
<h2 id="cargo_owner_name">NAME</h2>
<div class="sectionbody">
<p>cargo-owner - Manage the owners of a crate on the registry</p>
</div>
<div class="sect1">
<h2 id="cargo_owner_synopsis">SYNOPSIS</h2>
<div class="sectionbody">
<div class="paragraph">
<p><code>cargo owner [<em>OPTIONS</em>] --add <em>LOGIN</em> [<em>CRATE</em>]</code><br>
<code>cargo owner [<em>OPTIONS</em>] --remove <em>LOGIN</em> [<em>CRATE</em>]</code><br>
<code>cargo owner [<em>OPTIONS</em>] --list [<em>CRATE</em>]</code></p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="cargo_owner_description">DESCRIPTION</h2>
<div class="sectionbody">
<div class="paragraph">
<p>This command will modify the owners for a crate on the registry. Owners of a
crate can upload new versions and yank old versions. Non-team owners can also
modify the set of owners, so take care!</p>
</div>
<div class="paragraph">
<p>This command requires you to be authenticated with either the <code>--token</code> option
or using <a href="cargo-login.html">cargo-login(1)</a>.</p>
</div>
<div class="paragraph">
<p>If the crate name is not specified, it will use the package name from the
current directory.</p>
</div>
<div class="paragraph">
<p>See <a href="../reference/publishing.html#cargo-owner">the reference</a> for more
information about owners and publishing.</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="cargo_owner_options">OPTIONS</h2>
<div class="sectionbody">
<div class="sect2">
<h3 id="cargo_owner_owner_options">Owner Options</h3>
<div class="dlist">
<dl>
<dt class="hdlist1"><strong>-a</strong></dt>
<dt class="hdlist1"><strong>--add</strong> <em>LOGIN</em>…​</dt>
<dd>
<p>Invite the given user or team as an owner.</p>
</dd>
<dt class="hdlist1"><strong>-r</strong></dt>
<dt class="hdlist1"><strong>--remove</strong> <em>LOGIN</em>…​</dt>
<dd>
<p>Remove the given user or team as an owner.</p>
</dd>
<dt class="hdlist1"><strong>-l</strong></dt>
<dt class="hdlist1"><strong>--list</strong></dt>
<dd>
<p>List owners of a crate.</p>
</dd>
<dt class="hdlist1"><strong>--token</strong> <em>TOKEN</em></dt>
<dd>
<p>API token to use when authenticating. This overrides the token stored in
the credentials file (which is created by <a href="cargo-login.html">cargo-login(1)</a>).</p>
<div class="paragraph">
<p><a href="../reference/config.html">Cargo config</a> environment variables can be
used to override the tokens stored in the credentials file. The token for
crates.io may be specified with the <code>CARGO_REGISTRY_TOKEN</code> environment
variable. Tokens for other registries may be specified with environment
variables of the form <code>CARGO_REGISTRIES_NAME_TOKEN</code> where <code>NAME</code> is the name
of the registry in all capital letters.</p>
</div>
</dd>
<dt class="hdlist1"><strong>--index</strong> <em>INDEX</em></dt>
<dd>
<p>The URL of the registry index to use.</p>
</dd>
<dt class="hdlist1"><strong>--registry</strong> <em>REGISTRY</em></dt>
<dd>
<p>Name of the registry to use. Registry names are defined in <a href="../reference/config.html">Cargo config files</a>.
If not specified, the default registry is used, which is defined by the
<code>registry.default</code> config key which defaults to <code>crates-io</code>.</p>
</dd>
</dl>
</div>
</div>
<div class="sect2">
<h3 id="cargo_owner_display_options">Display Options</h3>
<div class="dlist">
<dl>
<dt class="hdlist1"><strong>-v</strong></dt>
<dt class="hdlist1"><strong>--verbose</strong></dt>
<dd>
<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="hdlist1"><strong>-q</strong></dt>
<dt class="hdlist1"><strong>--quiet</strong></dt>
<dd>
<p>No output printed to stdout.</p>
</dd>
<dt class="hdlist1"><strong>--color</strong> <em>WHEN</em></dt>
<dd>
<p>Control when colored output is used. Valid values:</p>
<div class="ulist">
<ul>
<li>
<p><code>auto</code> (default): Automatically detect if color support is available on the
terminal.</p>
</li>
<li>
<p><code>always</code>: Always display colors.</p>
</li>
<li>
<p><code>never</code>: Never display colors.</p>
</li>
</ul>
</div>
<div class="paragraph">
<p>May also be specified with the <code>term.color</code>
<a href="../reference/config.html">config value</a>.</p>
</div>
</dd>
</dl>
</div>
</div>
<div class="sect2">
<h3 id="cargo_owner_common_options">Common Options</h3>
<div class="dlist">
<dl>
<dt class="hdlist1"><strong>+TOOLCHAIN</strong></dt>
<dd>
<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://github.com/rust-lang/rustup/">rustup documentation</a>
for more information about how toolchain overrides work.</p>
</dd>
<dt class="hdlist1"><strong>-h</strong></dt>
<dt class="hdlist1"><strong>--help</strong></dt>
<dd>
<p>Prints help information.</p>
</dd>
<dt class="hdlist1"><strong>-Z</strong> <em>FLAG</em>…​</dt>
<dd>
<p>Unstable (nightly-only) flags to Cargo. Run <code>cargo -Z help</code> for
details.</p>
</dd>
</dl>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="cargo_owner_environment">ENVIRONMENT</h2>
<div class="sectionbody">
<div class="paragraph">
<p>See <a href="../reference/environment-variables.html">the reference</a> for
details on environment variables that Cargo reads.</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="cargo_owner_exit_status">Exit Status</h2>
<div class="sectionbody">
<div class="dlist">
<dl>
<dt class="hdlist1">0</dt>
<dd>
<p>Cargo succeeded.</p>
</dd>
<dt class="hdlist1">101</dt>
<dd>
<p>Cargo failed to complete.</p>
</dd>
</dl>
</div>
</div>
</div>
<div class="sect1">
<h2 id="cargo_owner_examples">EXAMPLES</h2>
<div class="sectionbody">
<div class="olist arabic">
<ol class="arabic">
<li>
<p>List owners of a package:</p>
<div class="literalblock">
<div class="content">
<pre>cargo owner --list foo</pre>
</div>
</div>
</li>
<li>
<p>Invite an owner to a package:</p>
<div class="literalblock">
<div class="content">
<pre>cargo owner --add username foo</pre>
</div>
</div>
</li>
<li>
<p>Remove an owner from a package:</p>
<div class="literalblock">
<div class="content">
<pre>cargo owner --remove username foo</pre>
</div>
</div>
</li>
</ol>
</div>
</div>
</div>
<div class="sect1">
<h2 id="cargo_owner_see_also">SEE ALSO</h2>
<div class="sectionbody">
<div class="paragraph">
<p><a href="index.html">cargo(1)</a>, <a href="cargo-login.html">cargo-login(1)</a>, <a href="cargo-publish.html">cargo-publish(1)</a></p>
</div>
</div>
</div>