Skip to main content
GitHub source Authenticate your machine with W&B. Store an API key locally for authenticating with W&B services. By default, credentials are stored without server-side verification. If no API key is provided as an argument, the command looks for credentials in the following order:
  1. The WANDB_API_KEY environment variable
  2. The api_key setting in a system or workspace settings file
  3. The .netrc file (~/.netrc, ~/_netrc, or the NETRC env var path)
  4. An interactive prompt (if a TTY is available)
For self-hosted or dedicated cloud deployments, specify the server URL with --host, or set the WANDB_BASE_URL environment variable. Examples: Log in interactively (prompts for API key) 
wandb login
Log in with an explicit API key 
wandb login YOUR_API_KEY
Log in and verify the API key is valid 
wandb login --verify
Log in to the W&B public cloud instead of a configured self-hosted instance 
wandb login --cloud
Log in to a self-hosted W&B instance 
wandb login --host https://my-wandb-server.example.com
Force a new login prompt even if already authenticated 
wandb login --relogin

​
Usage

wandb login [OPTIONS] [KEY]...

​
Arguments

​
key

NameDefaultType
keyNoneSTRING

​
Options

​
cloud

Log in to the W&B public cloud (https://api.wandb.ai). Mutually exclusive with —host.
FlagDefaultType
--cloudFalseBOOL

​
host

Log in to a specific W&B server instance by URL.
FlagDefaultType
--host, --base-urlNoneSTRING

​
relogin

Force a new login prompt, ignoring any existing credentials.
FlagDefaultType
--reloginNoneBOOL

​
anonymously

Log in anonymously
FlagDefaultType
--anonymouslyFalseBOOL

​
verify

Verify the API key with the W&B server after storing it.
FlagDefaultType
--verifyFalseBOOL

​
help

Show this message and exit.
FlagDefaultType
--helpFalseBOOL

​
CLI Help

Usage: login [OPTIONS] [KEY]...

  Authenticate your machine with W&B.

  Store an API key locally for authenticating with W&B services. By default,
  credentials are stored without server-side verification.

  If no API key is provided as an argument, the command looks for credentials
  in the following order:

  1. The WANDB_API_KEY environment variable 2. The api_key setting in a system
  or workspace settings file 3. The .netrc file (`~/.netrc`, `~/_netrc`, or
  the `NETRC` env var path) 4. An interactive prompt (if a TTY is available)

  For self-hosted or dedicated cloud deployments, specify the server URL with
  `--host`, or set the `WANDB_BASE_URL` environment variable.

  Examples:

  Log in interactively (prompts for API key)

  ```bash wandb login ```

  Log in with an explicit API key

  ```bash wandb login YOUR_API_KEY ```

  Log in and verify the API key is valid

  ```bash wandb login --verify ```

  Log in to the W&B public cloud instead of a configured self-hosted instance

  ```bash wandb login --cloud ```

  Log in to a self-hosted W&B instance

  ```bash wandb login --host https://my-wandb-server.example.com ```

  Force a new login prompt even if already authenticated

  ```bash wandb login --relogin ```

Options:
  --cloud                  Log in to the W&B public cloud
                           (https://api.wandb.ai). Mutually exclusive with
                           --host.
  --host, --base-url TEXT  Log in to a specific W&B server instance by URL.
  --relogin                Force a new login prompt, ignoring any existing
                           credentials.
  --verify / --no-verify   Verify the API key with the W&B server after
                           storing it.
  --help                   Show this message and exit.