Find everything you need to know about Coder all in one place. Access all documentation for Coder OSS for creating & managing CDEs today!

Open Source: Coder Docs | Coder

Learn how to install and run code-server using VS Code. Start here and access all documentation for code-server today!

code-server Docs: Run VS Code Anywhere | Coder

Start here and access all documentation for Coder Enterprise - all in one place. Discover all the features of our Enterprise solution today!

Enterprise: Coder Docs for Global Scale | Coder

All Coder v1 documentation in one place but keep in mind that Coder v1 is a retired product.  We encourage our customers to install Coder today!

Coder v1 Docs: Old Sunset Version | Coder

General

Agents

Applications

Audit

Authentication

Authorization

Builds

Debug

Enterprise

Files

Insights

Members

Organizations

PortSharing

Schemas

Templates

Users

WorkspaceProxies

Workspaces

REST API

Toggle auto-update policy for a workspace

autoupdate

coder

Install or update shell completion scripts for the detected or chosen shell.

completion

Add an SSH Host entry for your workspaces "ssh coder.workspace"

config-ssh

create

delete

Personalize your workspace by applying a canonical dotfiles repository

dotfiles

external-auth

external-auth access-token

favorite

features

features list

groups

groups create

groups delete

groups edit

groups list

licenses

licenses add

licenses delete

licenses list

list

login

logout

Print network debug information for DERP and STUN

netcheck

notifications

notifications pause

notifications resume

open

open vscode

ping

Forward ports from a workspace to the local machine. For reverse port forwarding, use "coder ssh -R".

port-forward

provisionerd

provisionerd start

Output your Coder public key used for Git operations

publickey

rename

Directly connect to the database to reset a user's password

reset-password

restart

Schedule automated start and stop times for workspaces

schedule

Override the stop time of a currently running workspace instance.

schedule override-stop

schedule show

schedule start

schedule stop

server

Create a new admin user with the given username, email and password and adds it to every organization.

server create-admin-user

server dbcrypt

server dbcrypt decrypt

Delete all encrypted data from the database. THIS IS A DESTRUCTIVE OPERATION.

server dbcrypt delete

server dbcrypt rotate

server postgres-builtin-serve

Output the connection URL for the built-in PostgreSQL deployment.

server postgres-builtin-url

Display details of a workspace's resources and agents

show

Run upload and download tests from your machine to a workspace

speedtest

start

Show resource usage for the current workspace.

stat

stat cpu

stat disk

stat mem

Manually manage Terraform state to fix broken workspaces

state

Pull a Terraform state file from a workspace.

state pull

Push a Terraform state file to a workspace.

state push

stop

Commands for troubleshooting issues with a Coder deployment.

support

Generate a support bundle to troubleshoot issues connecting to a workspace.

support bundle

templates

Archive unused or failed template versions from a given template(s)

templates archive

DEPRECATED: Create a template from the current directory or as specified by flag

templates create

templates delete

templates edit

templates init

List all the templates available for the organization

templates list

Download the active, latest, or specified version of a template to a path.

templates pull

Create or update a template from the current directory or as specified by flag

templates push

Manage different versions of the specified template

templates versions

templates versions archive

List all the versions of the specified template

templates versions list

templates versions unarchive

tokens

tokens create

tokens list

tokens remove

unfavorite

Will update and start a given workspace if it is out of date

update

users

Update a user's status to 'active'. Active users can fully interact with the platform

users activate

users create

users delete

users list

Show a single user. Use 'me' to indicate the currently authenticated user.

users show

Update a user's status to 'suspended'. A suspended user cannot log into the platform

users suspend

version

Fetch authenticated user info for Coder deployment

whoami

Command Line

Agent API

Reference

About

Screenshots

Home

Validated Architecture

Up to 1,000 users

Up to 2,000 users

Up to 3,000 users

Learn about validated and reference architectures for Coder

Architecture

Kubernetes

Install Coder with Docker / docker-compose

Docker

OpenShift

Run Coder in offline / air-gapped environments

Offline deployments

External database

Uninstall

Install Coder on a cloud provider with a single click

1-click install

Releases

Installation

Azure

Deploy workspaces on additional Kubernetes clusters

Additional clusters

Stream K8s event logs on workspace startup

Deployment logs

Other platforms

Platforms

Creating, editing, and updating templates

Working with templates

A tutorial for creating and editing your first template

Your first template

Guided tour

Template Dependencies

Change management

Provider authentication

Resource persistence

Terraform modules

Setting up templates

Show operational metrics in the workspace

Agent metadata

Show information in the workspace about template resources

Resource metadata

Learn how to manage the order of Terraform resources in UI

UI Resource Ordering

Give information and options to workspace users

Customizing templates

Templates define the infrastructure for workspaces