cargo-login — Save an API token from the registry locally


cargo login [options] [token]


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 may be retrieved from <>;.

Take care to keep the token secret, it should not be shared with anyone else.


Login Options

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
, --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

Do not print cargo log messages. May also be specified with the term.quiet config value <>;.

--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

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 <>; 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 <>; for more information.


Changes the current working directory before executing any specified operations. This affects things like where cargo looks by default for the project manifest (Cargo.toml), as well as the directories searched for discovering .cargo/config.toml, for example.

This option is only available on the nightly channel <>; and requires the -Z unstable-options flag to enable (see #10098 <>;).

-h, --help

Prints help information.

-Z flag

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


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


0: Cargo succeeded.

101: Cargo failed to complete.


1. Save the API token to disk:

cargo login


cargo(1), cargo-publish(1)