## Summary `coder login --first-user-trial=true` was unusable in non-interactive environments: the trial info fields could only be collected via interactive prompts, so scripted setup failed with a bare `EOF`. This adds flags and env vars for every trial info field, extracts the functions into a helper, turns the EOF into an actionable error, and fixes a related quirk where enabling the trial via env didn't reliably suppress the trial prompt. Fixes coder/coder#23264 ## Changes * Add a flag + env var for each trial field (matching the existing `first-user-*` convention): `--first-user-trial-{first-name,last-name,phone-number,job-title,company-name,country,developers}` and their `CODER_FIRST_USER_TRIAL_*` env vars. * When a trial field is missing with no input available, return an error naming the exact flag/env instead of a raw EOF. * Read `CODER_FIRST_USER_TRIAL` from `inv.Environ` instead of `os.Getenv` so the flag binding and the "Start a trial?" prompt gate agree (previously the env toggle could hit an EOF prompt that silently reset `trial` to `false`). * Regenerate `coder_login_--help.golden` and `docs/reference/cli/login.md`. ## Testing * Non-interactive login via flags and via env vars (env test asserts the trial is actually provisioned via a recording `TrialGenerator`). * Missing trial info returns the clear flag-naming error instead of hanging. * Existing interactive `TestLogin` subtests pass; `golangci-lint` clean. ## Notes No strict CLI validation of `country`/`developers` against the UI option lists: the server doesn't enforce them, and the existing fixture uses `developers=10-50` which isn't in the CLI bucket list. Can add if preferred. --- *Created by Coder Agents on behalf of* @snagles\*.\*
146 lines
5.4 KiB
Markdown
Generated
146 lines
5.4 KiB
Markdown
Generated
---
|
|
# Code generated by make gen. DO NOT EDIT.
|
|
title: login
|
|
description: Authenticate with Coder deployment
|
|
---
|
|
|
|
<!-- DO NOT EDIT | GENERATED CONTENT -->
|
|
|
|
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>](./login_token.md) | Print the current session token |
|
|
|
|
## Options
|
|
|
|
### --first-user-email
|
|
|
|
| | |
|
|
|-------------|--------------------------------------|
|
|
| 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.
|
|
|
|
### --first-user-password
|
|
|
|
| | |
|
|
|-------------|-----------------------------------------|
|
|
| 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
|
|
|
|
| | |
|
|
|-------------|--------------------------------------|
|
|
| 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.
|