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 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 dotfiles
Personalize your workspace by applying a canonical dotfiles repository external-auth
Manage external authentication features
List Enterprise features groups
Manage groups licenses
Add, delete, and list licenses list
List workspaces login
Authenticate with Coder deployment logout
Unauthenticate your local session netcheck
Print network debug information for DERP and STUN ping
Ping a workspace port-forward
Forward ports from a workspace to the local machine. For reverse port forwarding, use "coder ssh -R". provisionerd
Manage provisioner daemons 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 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 stat
Show resource usage for the current 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
Options
--debug-options
Print all options, how they're set, then exit.
--disable-direct-connections
Type bool
Environment $CODER_DISABLE_DIRECT_CONNECTIONS
Disable direct (P2P) connections to workspaces.
--global-config
Type string
Environment $CODER_CONFIG_DIR
Default ~/.config/coderv2
Path to the global coder
config directory.
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.
--no-feature-warning
Type bool
Environment $CODER_NO_FEATURE_WARNING
Suppress warnings about unlicensed features.
--no-version-warning
Type bool
Environment $CODER_NO_VERSION_WARNING
Suppress warning when client and server versions do not match.
--token
Type string
Environment $CODER_SESSION_TOKEN
Specify an authentication token. For security reasons setting
CODER_SESSION_TOKEN is preferred.
--url
Type url
Environment $CODER_URL
URL to a deployment.
-v, --verbose
Type bool
Environment $CODER_VERBOSE
Enable verbose output.