# coder login

Authenticate with Coder deployment

## Usage

```console
coder login [flags] [<url>]
```

## Description

```console
By default, the session token is stored in the operating system keyring on macOS and Windows and a plain text file on Linux. Use the --use-keyring flag or CODER_USE_KEYRING environment variable to change the storage mechanism.
```

## Subcommands

| Name                             | Purpose                         |
|----------------------------------|---------------------------------|
| [<code>token</code>](/docs/reference/cli/login/token/) | Print the current session token |

## Options

### --first-user-email

| Property    | Value                                |
|-------------|--------------------------------------|
| Type        | <code>string</code>                  |
| Environment | <code>$CODER_FIRST_USER_EMAIL</code> |

Specifies an email address to use if creating the first user for the deployment.

### --first-user-username

| Property    | Value                                   |
|-------------|-----------------------------------------|
| Type        | <code>string</code>                     |
| Environment | <code>$CODER_FIRST_USER_USERNAME</code> |

Specifies a username to use if creating the first user for the deployment.

### --first-user-full-name

| Property    | Value                                    |
|-------------|------------------------------------------|
| Type        | <code>string</code>                      |
| Environment | <code>$CODER_FIRST_USER_FULL_NAME</code> |

Specifies a human-readable name for the first user of the deployment.

### --first-user-password

| Property    | Value                                   |
|-------------|-----------------------------------------|
| Type        | <code>string</code>                     |
| Environment | <code>$CODER_FIRST_USER_PASSWORD</code> |

Specifies a password to use if creating the first user for the deployment.

### --first-user-setup-token

| Property    | Value                                      |
|-------------|--------------------------------------------|
| Type        | <code>string</code>                        |
| Environment | <code>$CODER_FIRST_USER_SETUP_TOKEN</code> |

Specifies the setup token to use if creating the first user for a deployment that requires one. The server prints it at startup.

### --first-user-trial

| Property    | Value                                |
|-------------|--------------------------------------|
| Type        | <code>bool</code>                    |
| Environment | <code>$CODER_FIRST_USER_TRIAL</code> |

Specifies whether a trial license should be provisioned for the Coder deployment or not.

### --first-user-trial-first-name

| Property    | Value                                           |
|-------------|-------------------------------------------------|
| Type        | <code>string</code>                             |
| Environment | <code>$CODER_FIRST_USER_TRIAL_FIRST_NAME</code> |

Specifies the first name of the first user for the deployment. Only used if --first-user-trial is set.

### --first-user-trial-last-name

| Property    | Value                                          |
|-------------|------------------------------------------------|
| Type        | <code>string</code>                            |
| Environment | <code>$CODER_FIRST_USER_TRIAL_LAST_NAME</code> |

Specifies the last name of the first user for the deployment. Only used if --first-user-trial is set.

### --first-user-trial-phone-number

| Property    | Value                                             |
|-------------|---------------------------------------------------|
| Type        | <code>string</code>                               |
| Environment | <code>$CODER_FIRST_USER_TRIAL_PHONE_NUMBER</code> |

Specifies the phone number of the first user for the deployment. Only used if --first-user-trial is set.

### --first-user-trial-job-title

| Property    | Value                                          |
|-------------|------------------------------------------------|
| Type        | <code>string</code>                            |
| Environment | <code>$CODER_FIRST_USER_TRIAL_JOB_TITLE</code> |

Specifies the job title of the first user for the deployment. Only used if --first-user-trial is set.

### --first-user-trial-company-name

| Property    | Value                                             |
|-------------|---------------------------------------------------|
| Type        | <code>string</code>                               |
| Environment | <code>$CODER_FIRST_USER_TRIAL_COMPANY_NAME</code> |

Specifies the company name of the first user for the deployment. Only used if --first-user-trial is set.

### --first-user-trial-country

| Property    | Value                                        |
|-------------|----------------------------------------------|
| Type        | <code>string</code>                          |
| Environment | <code>$CODER_FIRST_USER_TRIAL_COUNTRY</code> |

Specifies the country of the first user for the deployment. Only used if --first-user-trial is set.

### --first-user-trial-developers

| Property    | Value                                           |
|-------------|-------------------------------------------------|
| Type        | <code>string</code>                             |
| Environment | <code>$CODER_FIRST_USER_TRIAL_DEVELOPERS</code> |

Specifies the number of developers using the deployment. Only used if --first-user-trial is set.

### --use-token-as-session

| Property | Value             |
|----------|-------------------|
| Type     | <code>bool</code> |

By default, the CLI will generate a new session token when logging in. This flag will instead use the provided token as the session token.
