New
Boost Developer Productivity & Streamline Onboarding with CDE's

Download the Whitepaper

coder

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
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
dotfilesPersonalize your workspace by applying a canonical dotfiles repository
external-authManage external authentication
featuresList Enterprise features
groupsManage groups
licensesAdd, delete, and list licenses
listList workspaces
loginAuthenticate with Coder deployment
logoutUnauthenticate your local session
netcheckPrint network debug information for DERP and STUN
pingPing a workspace
port-forwardForward ports from a workspace to the local machine. For reverse port forwarding, use "coder ssh -R".
provisionerdManage provisioner daemons
publickeyOutput your Coder public key used for Git operations
renameRename a workspace
reset-passwordDirectly connect to the database to reset a user's password
restartRestart a workspace
scheduleSchedule automated start and stop times for workspaces
serverStart a Coder server
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.
stateManually manage Terraform state to fix broken workspaces
stopStop a workspace
templatesManage templates
tokensManage personal access tokens
updateWill update and start a given workspace if it is out of date
usersManage users
versionShow coder version

Options

--debug-options

Typebool

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

--disable-direct-connections

Typebool
Environment$CODER_DISABLE_DIRECT_CONNECTIONS

Disable direct (P2P) connections to workspaces.

--global-config

Typestring
Environment$CODER_CONFIG_DIR
Default~/.config/coderv2

Path to the global coder config directory.

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

--no-feature-warning

Typebool
Environment$CODER_NO_FEATURE_WARNING

Suppress warnings about unlicensed features.

--no-version-warning

Typebool
Environment$CODER_NO_VERSION_WARNING

Suppress warning when client and server versions do not match.

--token

Typestring
Environment$CODER_SESSION_TOKEN

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

--url

Typeurl
Environment$CODER_URL

URL to a deployment.

-v, --verbose

Typebool
Environment$CODER_VERBOSE

Enable verbose output.

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