coder/docs/cli.md

coder

Coder — A tool for provisioning self-hosted development environments with Terraform.

Usage

coder [flags]

Examples

  - Start a Coder server:

      $ coder server

  - Get started by creating a template from an example:

      $ coder templates init

Subcommands

Name	Purpose
config-ssh	Add an SSH Host entry for your workspaces "ssh coder.workspace"
create	Create a workspace
delete	Delete a workspace
dotfiles	Checkout and install a dotfiles repository from a Git URL
list	List workspaces
login	Authenticate with Coder deployment
logout	Unauthenticate your local session
ping	Ping a workspace
port-forward	Forward ports from machine to a workspace
publickey	Output your Coder public key used for Git operations
rename	Rename a workspace
reset-password	Directly connect to the database to reset a user's password
restart	Restart a workspace
scaletest	Run a scale test against the Coder API
schedule	Schedule automated start and stop times for workspaces
server	Start a Coder server
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
state	Manually manage Terraform state to fix broken workspaces
stop	Stop a workspace
templates	Manage templates
tokens	Manage personal access tokens
update	Will update and start a given workspace if it is out of date.
users	Manage users
version	Show coder version