CARGO-LOGIN
Section: User Commands (1)
Index
Return to Main Contents
NAME
cargo-login - Save an API token from the registry locally
SYNOPSIS
cargo login [options] [token]
DESCRIPTION
This command will save the API token to disk so that commands that require
authentication, such as cargo-publish(1), will be automatically
authenticated. The token is saved in $CARGO_HOME/credentials.toml. CARGO_HOME
defaults to .cargo in your home directory.
If the token argument is not specified, it will be read from stdin.
The API token for crates.io may be retrieved from <https://crates.io/me>.
Take care to keep the token secret, it should not be shared with anyone else.
OPTIONS
Login Options
--registry registry
-
Name of the registry to use. Registry names are defined in Cargo config
files <https://doc.rust-lang.org/cargo/reference/config.html>. 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 <https://doc.rust-lang.org/cargo/reference/config.html>.
-q,
--quiet
-
Do not print cargo log messages.
May also be specified with the term.quiet
config value <https://doc.rust-lang.org/cargo/reference/config.html>.
--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 <https://doc.rust-lang.org/cargo/reference/config.html>.
Common Options
+toolchain
-
If Cargo has been installed with rustup, and the first argument to cargo
begins with +, it will be interpreted as a rustup toolchain name (such
as +stable or +nightly).
See the rustup documentation <https://rust-lang.github.io/rustup/overrides.html>
for more information about how toolchain overrides work.
--config KEY=VALUE or PATH
-
Overrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE,
or provided as a path to an extra configuration file. This flag may be specified multiple times.
See the command-line overrides section <https://doc.rust-lang.org/cargo/reference/config.html#command-line-overrides> for more information.
-h,
--help
-
Prints help information.
-Z flag
-
Unstable (nightly-only) flags to Cargo. Run cargo -Z help for details.
ENVIRONMENT
See the reference <https://doc.rust-lang.org/cargo/reference/environment-variables.html> for
details on environment variables that Cargo reads.
EXIT STATUS
-
•0: Cargo succeeded.
-
•101: Cargo failed to complete.
EXAMPLES
-
1.Save the API token to disk:
-
cargo login
SEE ALSO
cargo(1), cargo-publish(1)
Index
- NAME
-
- SYNOPSIS
-
- DESCRIPTION
-
- OPTIONS
-
- Login Options
-
- Display Options
-
- Common Options
-
- ENVIRONMENT
-
- EXIT STATUS
-
- EXAMPLES
-
- SEE ALSO
-
This document was created by
man2html,
using the manual pages.
Time: 09:08:35 GMT, April 26, 2024