Usage

Options

coder

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

features

features list

groups

groups create

groups delete

groups edit

groups list

licenses

licenses add

licenses delete

licenses list

list

login

logout

ping

Forward ports from machine to a workspace

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

scaletest

Cleanup scaletest workspaces, then cleanup scaletest users.

scaletest cleanup

Creates many users, then creates a workspace for each user and waits for them finish building and fully come online. Optionally runs a command inside each workspace, and connects to the workspace over WireGuard.

scaletest create-workspaces

Generate traffic to scaletest workspaces through coderd

scaletest workspace-traffic

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

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

templates

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

Plan a template push from the current directory

templates plan

Download the latest version of a template to a path.

templates pull

Push a new template version from the current directory or as specified by flag

templates push

Manage different versions of the specified template

templates versions

List all the versions of the specified template

templates versions list

tokens

tokens create

tokens list

tokens remove

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

Command Line

Architecture

About

One-line install script for macOS and Linux

Install script

System packages for Debian, Ubuntu, Fedora, CentOS, RHEL, SUSE, and Alpine

System packages

Kubernetes

OpenShift

Install Coder with Docker / docker-compose

Docker

Windows

Download binaries for macOS, Windows, and Linux

Standalone binaries

Run Coder in offline / air-gapped environments

Offline deployments

External database

Uninstall

Installation

Azure

Deploy workspaces on additional Kubernetes clusters

Additional clusters

Other platforms

Platforms

Learn how resource persistence works in Coder

Resource Persistence

Learn how to authenticate the provisioner

Provider Authentication

Learn how to source-control templates with git and CI

Change Management

Learn how to expose resource data to users

Resource Metadata

Learn how to expose live agent information to users

Agent Metadata

Parameters

Learn how to add an "Open in Coder" button to your repos

Open in Coder

Use docker inside containerized templates

Docker in Workspaces

Learn about templates, which define the infrastructure underlying workspaces

Templates

Workspaces

Learn how to configure web IDEs in your templates

Web IDEs

Learn how to configure JetBrains Gateway for your workspaces

JetBrains Gateway

Learn how to configure Emacs with TRAMP in Coder

Emacs

Learn how to use Remote Desktops with Coder

Remote Desktops

Learn how to use your IDE of choice with Coder

IDEs

Port Forwarding

Networking

Dotfiles

Learn how to use secrets in your workspace

Secrets

Learn how to set up authentication using GitHub or OpenID Connect

Authentication

Learn about user roles available in Coder and how to create and manage users

Users

Groups

Learn how to use the role based access control

RBAC

Configuration

Learn how connect Coder with external git providers

Git Providers

Upgrading

Learn how to automate Coder with the CLI and API

Automation

Reference architecture and load testing tools

Scaling Coder

Run provisioners isolated from the Coder server

Provisioners

Workspace Proxies

Learn how to use Audit Logs in your Coder deployment

Audit Logs

Learn how to use Workspace Quotas in Coder

Quotas

Learn how to configure Coder for High Availability

High Availability

Prometheus

Learn how to configure the appearance of Coder

Appearance

Learn what usage telemetry Coder collects

Telemetry

Administration

Enterprise

See the code of conduct for contributing to Coder

Code of Conduct

Policies for Alpha and Experimental features.

Feature stages

Our style guide for use when authoring documentation

templates pull

templates pull

Usage

Options

--tar

-y, --yes