# coder ## Usage ```console coder [global-flags] ``` ## Description ```console 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 | | ------------------------------------------------------ | ----------------------------------------------------------------------------------------------------- | | [dotfiles](./cli/dotfiles.md) | Personalize your workspace by applying a canonical dotfiles repository | | [external-auth](./cli/external-auth.md) | Manage external authentication | | [login](./cli/login.md) | Authenticate with Coder deployment | | [logout](./cli/logout.md) | Unauthenticate your local session | | [netcheck](./cli/netcheck.md) | Print network debug information for DERP and STUN | | [port-forward](./cli/port-forward.md) | Forward ports from a workspace to the local machine. For reverse port forwarding, use "coder ssh -R". | | [publickey](./cli/publickey.md) | Output your Coder public key used for Git operations | | [reset-password](./cli/reset-password.md) | Directly connect to the database to reset a user's password | | [state](./cli/state.md) | Manually manage Terraform state to fix broken workspaces | | [templates](./cli/templates.md) | Manage templates | | [tokens](./cli/tokens.md) | Manage personal access tokens | | [users](./cli/users.md) | Manage users | | [version](./cli/version.md) | Show coder version | | [autoupdate](./cli/autoupdate.md) | Toggle auto-update policy for a workspace | | [config-ssh](./cli/config-ssh.md) | Add an SSH Host entry for your workspaces "ssh coder.workspace" | | [create](./cli/create.md) | Create a workspace | | [delete](./cli/delete.md) | Delete a workspace | | [favorite](./cli/favorite.md) | Add a workspace to your favorites | | [list](./cli/list.md) | List workspaces | | [open](./cli/open.md) | Open a workspace | | [ping](./cli/ping.md) | Ping a workspace | | [rename](./cli/rename.md) | Rename a workspace | | [restart](./cli/restart.md) | Restart a workspace | | [schedule](./cli/schedule.md) | Schedule automated start and stop times for workspaces | | [show](./cli/show.md) | Display details of a workspace's resources and agents | | [speedtest](./cli/speedtest.md) | Run upload and download tests from your machine to a workspace | | [ssh](./cli/ssh.md) | Start a shell into a workspace | | [start](./cli/start.md) | Start a workspace | | [stat](./cli/stat.md) | Show resource usage for the current workspace. | | [stop](./cli/stop.md) | Stop a workspace | | [unfavorite](./cli/unfavorite.md) | Remove a workspace from your favorites | | [update](./cli/update.md) | Will update and start a given workspace if it is out of date | | [support](./cli/support.md) | Commands for troubleshooting issues with a Coder deployment. | | [server](./cli/server.md) | Start a Coder server | | [features](./cli/features.md) | List Enterprise features | | [licenses](./cli/licenses.md) | Add, delete, and list licenses | | [groups](./cli/groups.md) | Manage groups | | [provisionerd](./cli/provisionerd.md) | Manage provisioner daemons | ## Options ### --url | | | | ----------- | ----------------------- | | Type | url | | Environment | $CODER_URL | URL to a deployment. ### --debug-options | | | | ---- | ----------------- | | Type | bool | Print all options, how they're set, then exit. ### --token | | | | ----------- | --------------------------------- | | Type | string | | Environment | $CODER_SESSION_TOKEN | Specify an authentication token. For security reasons setting CODER_SESSION_TOKEN is preferred. ### --no-version-warning | | | | ----------- | -------------------------------------- | | Type | bool | | Environment | $CODER_NO_VERSION_WARNING | Suppress warning when client and server versions do not match. ### --no-feature-warning | | | | ----------- | -------------------------------------- | | Type | bool | | Environment | $CODER_NO_FEATURE_WARNING | Suppress warnings about unlicensed features. ### --header | | | | ----------- | -------------------------- | | 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. ### -v, --verbose | | | | ----------- | --------------------------- | | Type | bool | | Environment | $CODER_VERBOSE | Enable verbose output. ### --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.