mirror of
https://github.com/coder/coder.git
synced 2025-07-09 11:45:56 +00:00
112 lines
4.7 KiB
Plaintext
112 lines
4.7 KiB
Plaintext
coder v0.0.0-devel
|
|
|
|
USAGE:
|
|
coder [global-flags] <subcommand>
|
|
|
|
Coder v0.0.0-devel — 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:
|
|
autoupdate Toggle auto-update policy for a workspace
|
|
completion Install or update shell completion scripts for the
|
|
detected or chosen shell.
|
|
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
|
|
favorite Add a workspace to your favorites
|
|
list List workspaces
|
|
login Authenticate with Coder deployment
|
|
logout Unauthenticate your local session
|
|
netcheck Print network debug information for DERP and STUN
|
|
notifications Manage Coder notifications
|
|
open Open a workspace
|
|
organizations Organization related commands
|
|
ping Ping a workspace
|
|
port-forward Forward ports from a workspace to the local machine. For
|
|
reverse port forwarding, use "coder ssh -R".
|
|
provisioner View and manage provisioner daemons and jobs
|
|
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
|
|
support Commands for troubleshooting issues with a Coder
|
|
deployment.
|
|
templates Manage templates
|
|
tokens Manage personal access tokens
|
|
unfavorite Remove a workspace from your favorites
|
|
update Will update and start a given workspace if it is out of
|
|
date
|
|
users Manage users
|
|
version Show coder version
|
|
whoami Fetch authenticated user info for Coder deployment
|
|
|
|
GLOBAL OPTIONS:
|
|
Global options are applied to all commands. They can be set using environment
|
|
variables or flags.
|
|
|
|
--debug-options bool
|
|
Print all options, how they're set, then exit.
|
|
|
|
--disable-direct-connections bool, $CODER_DISABLE_DIRECT_CONNECTIONS
|
|
Disable direct (P2P) connections to workspaces.
|
|
|
|
--disable-network-telemetry bool, $CODER_DISABLE_NETWORK_TELEMETRY
|
|
Disable network telemetry. Network telemetry is collected when
|
|
connecting to workspaces using the CLI, and is forwarded to the
|
|
server. If telemetry is also enabled on the server, it may be sent to
|
|
Coder. Network telemetry is used to measure network quality and detect
|
|
regressions.
|
|
|
|
--global-config string, $CODER_CONFIG_DIR (default: ~/.config/coderv2)
|
|
Path to the global `coder` config directory.
|
|
|
|
--header string-array, $CODER_HEADER
|
|
Additional HTTP headers added to all requests. Provide as key=value.
|
|
Can be specified multiple times.
|
|
|
|
--header-command string, $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 bool, $CODER_NO_FEATURE_WARNING
|
|
Suppress warnings about unlicensed features.
|
|
|
|
--no-version-warning bool, $CODER_NO_VERSION_WARNING
|
|
Suppress warning when client and server versions do not match.
|
|
|
|
--token string, $CODER_SESSION_TOKEN
|
|
Specify an authentication token. For security reasons setting
|
|
CODER_SESSION_TOKEN is preferred.
|
|
|
|
--url url, $CODER_URL
|
|
URL to a deployment.
|
|
|
|
-v, --verbose bool, $CODER_VERBOSE
|
|
Enable verbose output.
|
|
|
|
———
|
|
Report bugs and request features at https://github.com/coder/coder/issues/new
|