Reference
Command Line

coder

Usage

coder [global-flags] <subcommand>

Description

Coder — A tool for provisioning self-hosted development environments with Terraform.
  - Start a Coder server:

     $ coder server

  - Get started by creating a template from an example:

     $ coder templates init

Subcommands

NamePurpose
completionInstall or update shell completion scripts for the detected or chosen shell.
dotfilesPersonalize your workspace by applying a canonical dotfiles repository
external-authManage external authentication
loginAuthenticate with Coder deployment
logoutUnauthenticate your local session
netcheckPrint network debug information for DERP and STUN
notificationsManage Coder notifications
organizationsOrganization related commands
port-forwardForward ports from a workspace to the local machine. For reverse port forwarding, use "coder ssh -R".
publickeyOutput your Coder public key used for Git operations
reset-passwordDirectly connect to the database to reset a user's password
stateManually manage Terraform state to fix broken workspaces
templatesManage templates
tokensManage personal access tokens
usersManage users
versionShow coder version
autoupdateToggle auto-update policy for a workspace
config-sshAdd an SSH Host entry for your workspaces "ssh coder.workspace"
createCreate a workspace
deleteDelete a workspace
favoriteAdd a workspace to your favorites
listList workspaces
openOpen a workspace
pingPing a workspace
renameRename a workspace
restartRestart a workspace
scheduleSchedule automated start and stop times for workspaces
showDisplay details of a workspace's resources and agents
speedtestRun upload and download tests from your machine to a workspace
sshStart a shell into a workspace
startStart a workspace
statShow resource usage for the current workspace.
stopStop a workspace
unfavoriteRemove a workspace from your favorites
updateWill update and start a given workspace if it is out of date
whoamiFetch authenticated user info for Coder deployment
supportCommands for troubleshooting issues with a Coder deployment.
serverStart a Coder server
featuresList Enterprise features
licensesAdd, delete, and list licenses
groupsManage groups
provisionerManage provisioner daemons

Options

--url

Typeurl
Environment$CODER_URL

URL to a deployment.

--debug-options

Typebool

Print all options, how they're set, then exit.

--token

Typestring
Environment$CODER_SESSION_TOKEN

Specify an authentication token. For security reasons setting CODER_SESSION_TOKEN is preferred.

--no-version-warning

Typebool
Environment$CODER_NO_VERSION_WARNING

Suppress warning when client and server versions do not match.

--no-feature-warning

Typebool
Environment$CODER_NO_FEATURE_WARNING

Suppress warnings about unlicensed features.

--header

Typestring-array
Environment$CODER_HEADER

Additional HTTP headers added to all requests. Provide as key=value. Can be specified multiple times.

--header-command

Typestring
Environment$CODER_HEADER_COMMAND

An external command that outputs additional HTTP headers added to all requests. The command must output each header as key=value on its own line.

-v, --verbose

Typebool
Environment$CODER_VERBOSE

Enable verbose output.

--disable-direct-connections

Typebool
Environment$CODER_DISABLE_DIRECT_CONNECTIONS

Disable direct (P2P) connections to workspaces.

--disable-network-telemetry

Typebool
Environment$CODER_DISABLE_NETWORK_TELEMETRY

Disable network telemetry. Network telemetry is collected when connecting to workspaces using the CLI, and is forwarded to the server. If telemetry is also enabled on the server, it may be sent to Coder. Network telemetry is used to measure network quality and detect regressions.

--global-config

Typestring
Environment$CODER_CONFIG_DIR
Default~/.config/coderv2

Path to the global coder config directory.

See an opportunity to improve our docs? Make an edit.