coder/docs/reference/cli/login.md at main

mirror of https://github.com/coder/coder.git synced 2026-06-02 20:48:20 +00:00

Files

T

Kacper Sawicki d09300eadf feat(cli): add 'coder login token' command to print session token (#21627 )

Adds a new subcommand to print the current session token for use in
scripts and automation, similar to `gh auth token`.

## Usage

```bash
CODER_SESSION_TOKEN=$(coder login token)
```

Fixes #21515

2026-01-29 16:06:17 +01:00

2.5 KiB

Generated

Raw Permalink Blame History

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


Type	`string`
Environment	`$CODER_FIRST_USER_EMAIL`

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

--first-user-username


Type	`string`
Environment	`$CODER_FIRST_USER_USERNAME`

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

--first-user-full-name


Type	`string`
Environment	`$CODER_FIRST_USER_FULL_NAME`

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

--first-user-password


Type	`string`
Environment	`$CODER_FIRST_USER_PASSWORD`

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

--first-user-trial


Type	`bool`
Environment	`$CODER_FIRST_USER_TRIAL`

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

--use-token-as-session


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.

2.5 KiB Generated Raw Permalink Blame History

login