HomeReferenceCommand Linecoder login

`coder login`

On this page

Authenticate with Coder deployment

Usage

coder login [flags] [<url>]

Description

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
`token`	Print the current session token

Options

--first-user-email

Property	Value
Type	`string`
Environment	`$CODER_FIRST_USER_EMAIL`

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

--first-user-username

Property	Value
Type	`string`
Environment	`$CODER_FIRST_USER_USERNAME`

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

--first-user-full-name

Property	Value
Type	`string`
Environment	`$CODER_FIRST_USER_FULL_NAME`

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

--first-user-password

Property	Value
Type	`string`
Environment	`$CODER_FIRST_USER_PASSWORD`

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

--first-user-trial

Property	Value
Type	`bool`
Environment	`$CODER_FIRST_USER_TRIAL`

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

--first-user-trial-first-name

Property	Value
Type	`string`
Environment	`$CODER_FIRST_USER_TRIAL_FIRST_NAME`

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	`string`
Environment	`$CODER_FIRST_USER_TRIAL_LAST_NAME`

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	`string`
Environment	`$CODER_FIRST_USER_TRIAL_PHONE_NUMBER`

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	`string`
Environment	`$CODER_FIRST_USER_TRIAL_JOB_TITLE`

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	`string`
Environment	`$CODER_FIRST_USER_TRIAL_COMPANY_NAME`

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	`string`
Environment	`$CODER_FIRST_USER_TRIAL_COUNTRY`

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	`string`
Environment	`$CODER_FIRST_USER_TRIAL_DEVELOPERS`

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

--use-token-as-session

Property	Value
Type	`bool`

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.