Files
coder/cli/testdata/coder_--help.golden
T

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

124 lines
5.3 KiB
Plaintext
Raw Normal View History

2023-09-08 13:21:33 -05:00
coder v0.0.0-devel
2023-03-23 17:42:20 -05:00
USAGE:
2023-09-08 13:21:33 -05:00
coder [global-flags] <subcommand>
2023-09-08 13:21:33 -05:00
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
2024-08-20 14:47:46 +10:00
completion Install or update shell completion scripts for the
detected or chosen shell.
2023-03-23 17:42:20 -05:00
config-ssh Add an SSH Host entry for your workspaces "ssh
workspace.coder"
2023-03-23 17:42:20 -05:00
create Create a workspace
delete Delete a workspace
dotfiles Personalize your workspace by applying a canonical
dotfiles repository
2023-10-09 18:04:35 -05:00
external-auth Manage external authentication
favorite Add a workspace to your favorites
2023-03-23 17:42:20 -05:00
list List workspaces
login Authenticate with Coder deployment
logout Unauthenticate your local session
2026-01-08 09:58:10 +00:00
logs View logs for a workspace
2023-07-10 21:38:02 -05:00
netcheck Print network debug information for DERP and STUN
2024-07-11 15:22:20 +02:00
notifications Manage Coder notifications
2024-01-02 20:46:18 +02:00
open Open a workspace
organizations Organization related commands
2023-03-23 17:42:20 -05:00
ping Ping a workspace
2023-07-24 21:22:41 -05:00
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
2023-03-23 17:42:20 -05:00
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 or run a command
2023-03-23 17:42:20 -05:00
start Start a workspace
2023-06-20 10:16:57 +01:00
stat Show resource usage for the current workspace.
2023-03-23 17:42:20 -05:00
state Manually manage Terraform state to fix broken workspaces
stop Stop a workspace
support Commands for troubleshooting issues with a Coder
deployment.
task Manage tasks
2023-03-23 17:42:20 -05:00
templates Manage templates
tokens Manage personal access tokens
unfavorite Remove a workspace from your favorites
2023-03-23 17:42:20 -05:00
update Will update and start a given workspace if it is out of
2025-06-23 09:12:37 +01:00
date. If the workspace is already running, it will be
stopped first.
2023-03-23 17:42:20 -05:00
users Manage users
version Show coder version
whoami Fetch authenticated user info for Coder deployment
GLOBAL OPTIONS:
2023-03-23 17:42:20 -05:00
Global options are applied to all commands. They can be set using environment
variables or flags.
--debug-options bool
2023-04-07 17:58:21 -05:00
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.
2025-03-25 10:25:35 +01:00
--force-tty bool, $CODER_FORCE_TTY
Force the use of a TTY.
--global-config string, $CODER_CONFIG_DIR (default: ~/.config/coderv2)
2023-03-23 17:42:20 -05:00
Path to the global `coder` config directory.
--header string-array, $CODER_HEADER
2023-03-23 17:42:20 -05:00
Additional HTTP headers added to all requests. Provide as key=value.
Can be specified multiple times.
--header-command string, $CODER_HEADER_COMMAND
2023-08-14 12:12:17 -08: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.
--no-feature-warning bool, $CODER_NO_FEATURE_WARNING
2023-03-23 17:42:20 -05:00
Suppress warnings about unlicensed features.
--no-version-warning bool, $CODER_NO_VERSION_WARNING
2023-03-23 17:42:20 -05:00
Suppress warning when client and server versions do not match.
--token string, $CODER_SESSION_TOKEN
2023-03-23 17:42:20 -05:00
Specify an authentication token. For security reasons setting
CODER_SESSION_TOKEN is preferred.
--url url, $CODER_URL
2023-03-23 17:42:20 -05:00
URL to a deployment.
--use-keyring bool, $CODER_USE_KEYRING (default: true)
Store and retrieve session tokens using the operating system keyring.
This flag is ignored and file-based storage is used when
--global-config is set or keyring usage is not supported on the
current platform. Set to false to force file-based storage on
supported platforms.
-v, --verbose bool, $CODER_VERBOSE
2023-03-23 17:42:20 -05:00
Enable verbose output.
2023-09-08 13:21:33 -05:00
———
2023-03-23 17:42:20 -05:00
Report bugs and request features at https://github.com/coder/coder/issues/new