cargo login

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 requireauthentication, such as cargo-publish(1), will be automaticallyauthenticated. The token is saved in $CARGO_HOME/credentials. CARGO_HOMEdefaults 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

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

  • Save the API token to disk:
  1. cargo login

SEE ALSO

cargo(1), cargo-publish(1)