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