Files
coder/docs/reference/cli/login.md
T

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

145 lines
5.4 KiB
Markdown
Raw Normal View History

---
# Code generated by make gen. DO NOT EDIT.
title: login
description: Authenticate with Coder deployment
---
2023-03-23 17:42:20 -05:00
<!-- DO NOT EDIT | GENERATED CONTENT -->
Authenticate with Coder deployment
## Usage
```console
coder login [flags] [<url>]
2023-03-23 17:42:20 -05:00
```
## 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>](./login_token.md) | Print the current session token |
2023-03-23 17:42:20 -05:00
## Options
### --first-user-email
| | |
|-------------|--------------------------------------|
2023-03-23 17:42:20 -05:00
| 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
| | |
|-------------|-----------------------------------------|
| 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
| | |
|-------------|------------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_FIRST_USER_FULL_NAME</code> |
Specifies a human-readable name for the first user of the deployment.
2023-03-23 17:42:20 -05:00
### --first-user-password
| | |
|-------------|-----------------------------------------|
2023-03-23 17:42:20 -05:00
| 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
| | |
|-------------|--------------------------------------|
2023-03-23 17:42:20 -05:00
| 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
| | |
|-------------|-------------------------------------------------|
| 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
| | |
|-------------|------------------------------------------------|
| 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
| | |
|-------------|---------------------------------------------------|
| 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
| | |
|-------------|------------------------------------------------|
| 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
| | |
|-------------|---------------------------------------------------|
| 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
| | |
|-------------|----------------------------------------------|
| 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
| | |
|-------------|-------------------------------------------------|
| 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
| | |
|------|-------------------|
| 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.