coder/docs/reference/cli/login.md at 4a97df3768eee06e9ea8eb5fa408eae0932e3778

mirror of https://github.com/coder/coder.git synced 2026-06-03 04:58:23 +00:00

Files

T

Zach 6238a99275 feat(cli)!: enable keyring usage by default (#20851 )

Make keyring usage for session token storage on by default for supported
platforms (Windows and macOS), with the ability to opt-out via
--use-keyring=false.

This change will be a breaking change for any users depending on the
session token being stored on disk, though users can restore file usage
via the flag above.

This change will also require CLI users to authenticate after updating.

2025-11-25 18:13:00 -07:00

2.3 KiB

Generated

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

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.3 KiB Generated Raw Blame History

login