> ## Documentation Index
> Fetch the complete documentation index at: https://docs.wandb.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# wandb login

export const GitHubLink = ({url}) => <a href={url} target="_blank" rel="noopener noreferrer" className="github-source-link">
    <svg width="20" height="20" viewBox="0 0 24 24" fill="currentColor" xmlns="http://www.w3.org/2000/svg">
      <path d="M12 0C5.37 0 0 5.37 0 12c0 5.31 3.435 9.795 8.205 11.385.6.105.825-.255.825-.57 0-.285-.015-1.23-.015-2.235-3.015.555-3.795-.735-4.035-1.41-.135-.345-.72-1.41-1.23-1.695-.42-.225-1.02-.78-.015-.795.945-.015 1.62.87 1.845 1.23 1.08 1.815 2.805 1.305 3.495.99.105-.78.42-1.305.765-1.605-2.67-.3-5.46-1.335-5.46-5.925 0-1.305.465-2.385 1.23-3.225-.12-.3-.54-1.53.12-3.18 0 0 1.005-.315 3.3 1.23.96-.27 1.98-.405 3-.405s2.04.135 3 .405c2.295-1.56 3.3-1.23 3.3-1.23.66 1.65.24 2.88.12 3.18.765.84 1.23 1.905 1.23 3.225 0 4.605-2.805 5.625-5.475 5.925.435.375.81 1.095.81 2.22 0 1.605-.015 2.895-.015 3.3 0 .315.225.69.825.57A12.02 12.02 0 0024 12c0-6.63-5.37-12-12-12z" />
    </svg>
    GitHub source
  </a>;

<GitHubLink url="https://github.com/wandb/wandb/blob/v0.26.1/wandb/cli/cli.py#L263" />

## Usage

```bash theme={null}
login [OPTIONS] [KEY]...
```

## Description

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 (use
   `wandb status` to see which settings file is used)

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.

For example, to log in interactively (prompts for API key):

```bash theme={null}
wandb login
```

To log in with an explicit API key (WANDB\_API\_KEY\_EXAMPLE):

```bash theme={null}
wandb login WANDB_API_KEY_EXAMPLE
```

To log in and verify the API key is valid:

```bash theme={null}
wandb login --verify
```

To log in to the W\&B public cloud instead of a configured self-hosted instance:

```bash theme={null}
wandb login --cloud
```

To log in to a self-hosted W\&B instance:

```bash theme={null}
wandb login --host https://my-wandb-server.example.com
```

To force a new login prompt even if already authenticated:

```bash theme={null}
wandb login --relogin
```

## Arguments

| Name  | Default | Type  |
| ----- | ------- | ----- |
| `key` | STR     | False |

## Options

| Flag                 | Type      | Description                                                                                                                                                              |
| -------------------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `--cloud`            | BOOL Flag | Log in to the W\&B public cloud ([https://api.wandb.ai](https://api.wandb.ai)). Mutually exclusive with --host. **Default**: False                                       |
| `--host, --base-url` | STR       | Log in to a specific W\&B server instance by URL (e.g. [https://my-wandb.example.com](https://my-wandb.example.com)). Mutually exclusive with --cloud. **Default**: None |
| `--relogin`          | BOOL Flag | Force a new login prompt, ignoring any existing credentials. **Default**: None                                                                                           |
| `--verify`           | BOOL Flag | Verify the API key with W\&B after storing it. If verification is successful, display the source of the credentials and the default team. **Default**: False             |