Skip to content

login.md

Latest commit

 

History

History
82 lines (55 loc) · 2.63 KB

login.md

File metadata and controls

82 lines (55 loc) · 2.63 KB
Raw
title login
description Authenticate with Coder deployment

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.