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

Sections

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

organizations

organizations create

organizations members

Add a new member to the current organization

organizations members add

organizations members edit-roles

organizations members list

Remove a new member to the current organization

organizations members remove

organizations roles

organizations roles edit

organizations roles show

organizations settings

organizations settings set

Group sync settings to sync groups from an IdP.

organizations settings set group-sync

Organization sync settings to sync organization memberships from an IdP.

organizations settings set organization-sync

Role sync settings to sync organization roles from an IdP.

organizations settings set role-sync

organizations settings show

organizations settings show group-sync

organizations settings show organization-sync

organizations settings show role-sync

Show the organization. Using "selected" will show the selected organization from the "--org" flag. Using "me" will show all organizations you are a member of.

organizations show

ping

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

port-forward

provisioner

provisioner keys

provisioner keys create

provisioner keys delete

provisioner keys list

provisioner 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

Command Line

Agent API

Reference

About

Coder quickstart

Screenshots

Home

Coder CLI

Docker

Kubernetes

OpenShift

AWS EC2

GCP Compute Engine

Azure VM

Cloud Providers

Run Coder in offline / air-gapped environments

Offline Deployments

Unofficial Install Methods

Upgrading

Uninstall

Learn about the Coder release channels and schedule

Releases

Install

Use VSCode with Coder in the desktop or browser

Visual Studio Code

JetBrains IDEs

Remote Desktop

Emacs TRAMP

Port Forwarding

Filebrowser

Access your workspace with IDEs in the browser

Web IDEs and Coder Apps

Access Workspaces

Workspace Management

Workspace Scheduling

Workspace Lifecycle

Personalize your environment with dotfiles

Dotfiles

User Guides

Learn how to configure the appearance of Coder

Appearance

Configure user access to your control plane.

Setup

Guides for template and deployment administrators