2023-02-23 01:53:21 +00:00
<!-- DO NOT EDIT | GENERATED CONTENT -->
# coder
## Usage
```console
2023-03-23 22:42:20 +00:00
coder [global-flags] < subcommand >
2023-02-23 01:53:21 +00:00
```
2023-03-23 22:42:20 +00:00
## Description
2023-02-23 01:53:21 +00:00
```console
2023-03-23 22:42:20 +00:00
Coder — A tool for provisioning self-hosted development environments with Terraform.
2023-02-23 01:53:21 +00:00
- Start a Coder server:
2023-09-07 21:28:22 +00:00
$ coder server
2023-02-23 01:53:21 +00:00
- Get started by creating a template from an example:
2023-09-07 21:28:22 +00:00
$ coder templates init
2023-02-23 01:53:21 +00:00
```
## Subcommands
2023-07-25 02:22:41 +00:00
| Name | Purpose |
| ------------------------------------------------------ | ----------------------------------------------------------------------------------------------------- |
2024-03-15 16:24:38 +00:00
| [<code>dotfiles</code> ](./cli/dotfiles.md ) | Personalize your workspace by applying a canonical dotfiles repository |
| [<code>external-auth</code> ](./cli/external-auth.md ) | Manage external authentication |
| [<code>login</code> ](./cli/login.md ) | Authenticate with Coder deployment |
| [<code>logout</code> ](./cli/logout.md ) | Unauthenticate your local session |
| [<code>netcheck</code> ](./cli/netcheck.md ) | Print network debug information for DERP and STUN |
| [<code>port-forward</code> ](./cli/port-forward.md ) | Forward ports from a workspace to the local machine. For reverse port forwarding, use "coder ssh -R". |
| [<code>publickey</code> ](./cli/publickey.md ) | Output your Coder public key used for Git operations |
| [<code>reset-password</code> ](./cli/reset-password.md ) | Directly connect to the database to reset a user's password |
| [<code>state</code> ](./cli/state.md ) | Manually manage Terraform state to fix broken workspaces |
| [<code>templates</code> ](./cli/templates.md ) | Manage templates |
| [<code>tokens</code> ](./cli/tokens.md ) | Manage personal access tokens |
| [<code>users</code> ](./cli/users.md ) | Manage users |
| [<code>version</code> ](./cli/version.md ) | Show coder version |
2023-11-02 19:41:34 +00:00
| [<code>autoupdate</code> ](./cli/autoupdate.md ) | Toggle auto-update policy for a workspace |
2023-07-25 02:22:41 +00:00
| [<code>config-ssh</code> ](./cli/config-ssh.md ) | Add an SSH Host entry for your workspaces "ssh coder.workspace" |
| [<code>create</code> ](./cli/create.md ) | Create a workspace |
| [<code>delete</code> ](./cli/delete.md ) | Delete a workspace |
2024-01-24 14:05:39 +00:00
| [<code>favorite</code> ](./cli/favorite.md ) | Add a workspace to your favorites |
2023-07-25 02:22:41 +00:00
| [<code>list</code> ](./cli/list.md ) | List workspaces |
2024-01-02 18:46:18 +00:00
| [<code>open</code> ](./cli/open.md ) | Open a workspace |
2023-07-25 02:22:41 +00:00
| [<code>ping</code> ](./cli/ping.md ) | Ping a workspace |
| [<code>rename</code> ](./cli/rename.md ) | Rename a workspace |
| [<code>restart</code> ](./cli/restart.md ) | Restart a workspace |
| [<code>schedule</code> ](./cli/schedule.md ) | Schedule automated start and stop times for workspaces |
| [<code>show</code> ](./cli/show.md ) | Display details of a workspace's resources and agents |
| [<code>speedtest</code> ](./cli/speedtest.md ) | Run upload and download tests from your machine to a workspace |
| [<code>ssh</code> ](./cli/ssh.md ) | Start a shell into a workspace |
| [<code>start</code> ](./cli/start.md ) | Start a workspace |
| [<code>stat</code> ](./cli/stat.md ) | Show resource usage for the current workspace. |
| [<code>stop</code> ](./cli/stop.md ) | Stop a workspace |
2024-01-24 14:05:39 +00:00
| [<code>unfavorite</code> ](./cli/unfavorite.md ) | Remove a workspace from your favorites |
2023-07-25 02:22:41 +00:00
| [<code>update</code> ](./cli/update.md ) | Will update and start a given workspace if it is out of date |
2024-03-25 15:14:27 +00:00
| [<code>support</code> ](./cli/support.md ) | Commands for troubleshooting issues with a Coder deployment. |
2024-03-15 16:24:38 +00:00
| [<code>server</code> ](./cli/server.md ) | Start a Coder server |
| [<code>features</code> ](./cli/features.md ) | List Enterprise features |
| [<code>licenses</code> ](./cli/licenses.md ) | Add, delete, and list licenses |
| [<code>groups</code> ](./cli/groups.md ) | Manage groups |
| [<code>provisionerd</code> ](./cli/provisionerd.md ) | Manage provisioner daemons |
2023-03-23 22:42:20 +00:00
## Options
2024-03-15 16:24:38 +00:00
### --url
| | |
| ----------- | ----------------------- |
| Type | < code > url< / code > |
| Environment | < code > $CODER_URL< / code > |
URL to a deployment.
2023-04-07 22:58:21 +00:00
### --debug-options
| | |
| ---- | ----------------- |
| Type | < code > bool< / code > |
Print all options, how they're set, then exit.
2024-03-15 16:24:38 +00:00
### --token
2023-06-21 20:22:43 +00:00
2024-03-15 16:24:38 +00:00
| | |
| ----------- | --------------------------------- |
| Type | < code > string< / code > |
| Environment | < code > $CODER_SESSION_TOKEN< / code > |
2023-06-21 20:22:43 +00:00
2024-03-15 16:24:38 +00:00
Specify an authentication token. For security reasons setting
CODER_SESSION_TOKEN is preferred.
2023-06-21 20:22:43 +00:00
2024-03-15 16:24:38 +00:00
### --no-version-warning
2023-03-23 22:42:20 +00:00
2024-03-15 16:24:38 +00:00
| | |
| ----------- | -------------------------------------- |
| Type | < code > bool< / code > |
| Environment | < code > $CODER_NO_VERSION_WARNING< / code > |
2023-03-23 22:42:20 +00:00
2024-03-15 16:24:38 +00:00
Suppress warning when client and server versions do not match.
### --no-feature-warning
| | |
| ----------- | -------------------------------------- |
| Type | < code > bool< / code > |
| Environment | < code > $CODER_NO_FEATURE_WARNING< / code > |
Suppress warnings about unlicensed features.
2023-03-23 22:42:20 +00:00
### --header
| | |
| ----------- | -------------------------- |
| Type | < code > string-array< / code > |
| Environment | < code > $CODER_HEADER< / code > |
2023-08-23 09:27:57 +00:00
Additional HTTP headers added to all requests. Provide as key=value. Can be
specified multiple times.
2023-03-23 22:42:20 +00:00
2023-08-14 20:12:17 +00:00
### --header-command
| | |
| ----------- | ---------------------------------- |
| Type | < code > string< / code > |
| Environment | < code > $CODER_HEADER_COMMAND< / code > |
2023-08-23 09:27:57 +00:00
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.
2023-08-14 20:12:17 +00:00
2024-03-15 16:24:38 +00:00
### -v, --verbose
2023-03-23 22:42:20 +00:00
2024-03-15 16:24:38 +00:00
| | |
| ----------- | --------------------------- |
| Type | < code > bool< / code > |
| Environment | < code > $CODER_VERBOSE< / code > |
2023-03-23 22:42:20 +00:00
2024-03-15 16:24:38 +00:00
Enable verbose output.
2023-03-23 22:42:20 +00:00
2024-03-15 16:24:38 +00:00
### --disable-direct-connections
2023-03-23 22:42:20 +00:00
2024-03-15 16:24:38 +00:00
| | |
| ----------- | ---------------------------------------------- |
| Type | < code > bool< / code > |
| Environment | < code > $CODER_DISABLE_DIRECT_CONNECTIONS< / code > |
2023-03-23 22:42:20 +00:00
2024-03-15 16:24:38 +00:00
Disable direct (P2P) connections to workspaces.
### --global-config
| | |
| ----------- | ------------------------------ |
| Type | < code > string< / code > |
| Environment | < code > $CODER_CONFIG_DIR< / code > |
| Default | < code > ~/.config/coderv2< / code > |
Path to the global `coder` config directory.