CLI Reference Guide | Coder Docs

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

Name	Purpose
`completion`	Install or update shell completion scripts for the detected or chosen shell.
`dotfiles`	Personalize your workspace by applying a canonical dotfiles repository
`external-auth`	Manage external authentication
`login`	Authenticate with Coder deployment
`logout`	Unauthenticate your local session
`netcheck`	Print network debug information for DERP and STUN
`notifications`	Manage Coder notifications
`organizations`	Organization related commands
`port-forward`	Forward ports from a workspace to the local machine. For reverse port forwarding, use "coder ssh -R".
`publickey`	Output your Coder public key used for Git operations
`reset-password`	Directly connect to the database to reset a user's password
`state`	Manually manage Terraform state to fix broken workspaces
`templates`	Manage templates
`tokens`	Manage personal access tokens
`users`	Manage users
`version`	Show coder version
`autoupdate`	Toggle auto-update policy for a workspace
`config-ssh`	Add an SSH Host entry for your workspaces "ssh coder.workspace"
`create`	Create a workspace
`delete`	Delete a workspace
`favorite`	Add a workspace to your favorites
`list`	List workspaces
`open`	Open a workspace
`ping`	Ping a workspace
`rename`	Rename a workspace
`restart`	Restart a workspace
`schedule`	Schedule automated start and stop times for workspaces
`show`	Display details of a workspace's resources and agents
`speedtest`	Run upload and download tests from your machine to a workspace
`ssh`	Start a shell into a workspace
`start`	Start a workspace
`stat`	Show resource usage for the current workspace.
`stop`	Stop a workspace
`unfavorite`	Remove a workspace from your favorites
`update`	Will update and start a given workspace if it is out of date
`whoami`	Fetch authenticated user info for Coder deployment
`support`	Commands for troubleshooting issues with a Coder deployment.
`server`	Start a Coder server
`features`	List Enterprise features
`licenses`	Add, delete, and list licenses
`groups`	Manage groups
`provisioner`	Manage provisioner daemons

Options

--url


Type	`url`
Environment	`$CODER_URL`

URL to a deployment.

--debug-options


Type	`bool`

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

--token


Type	`string`
Environment	`$CODER_SESSION_TOKEN`

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

--no-version-warning


Type	`bool`
Environment	`$CODER_NO_VERSION_WARNING`

Suppress warning when client and server versions do not match.

--no-feature-warning


Type	`bool`
Environment	`$CODER_NO_FEATURE_WARNING`

Suppress warnings about unlicensed features.


Type	`string-array`
Environment	`$CODER_HEADER`

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

--header-command


Type	`string`
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


Type	`bool`
Environment	`$CODER_VERBOSE`

Enable verbose output.

--disable-direct-connections


Type	`bool`
Environment	`$CODER_DISABLE_DIRECT_CONNECTIONS`

Disable direct (P2P) connections to workspaces.

--disable-network-telemetry


Type	`bool`
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


Type	`string`
Environment	`$CODER_CONFIG_DIR`
Default	`~/.config/coderv2`

Path to the global coder config directory.

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

On this page