`coder workspace-proxy` (`wsproxy`) has been hidden since it was added for manual testing in #7176, although `docs/admin/networking/workspace-proxies.md` tells admins to run it. This removes `Hidden: true`, regenerates `docs/reference/cli/workspace-proxy/*`, adds them to the docs manifest, and corrects "Display of the proxy" to "Display name of the proxy" in the `create` and `edit` help. **Behavior change:** `coder workspace-proxy` and its subcommands now appear in `coder --help`. The commands themselves are unchanged. <details> <summary>Decisions</summary> - `server` stays visible. Its reference page is 447 lines, about a fifth of `coder server`, because it only lists proxy-relevant options. - Rough edge not fixed here: `create` and `regenerate-token` print the proxy token in cleartext, including in the default table columns. That's consistent with other show-once secrets but worth a docs callout. - Most of this diff is generated reference pages. </details> Closes [CLI-28](https://linear.app/codercom/issue/CLI-28) _This PR was generated by Coder Agents on behalf of @nickvigilante._
107 lines
4.3 KiB
Plaintext
107 lines
4.3 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:
|
|
agent-firewall Network isolation tool for monitoring and restricting
|
|
HTTP/HTTPS requests
|
|
ai-gateway Manage AI Gateway
|
|
external-workspaces Create or manage external workspaces
|
|
features List Enterprise features
|
|
groups Manage groups
|
|
licenses Add, delete, and list licenses
|
|
prebuilds Manage Coder prebuilds
|
|
provisioner View and manage provisioner daemons and jobs
|
|
server Start a Coder server
|
|
workspace-proxy Workspace proxies provide low-latency experiences for
|
|
geo-distributed teams.
|
|
|
|
GLOBAL OPTIONS:
|
|
Global options are applied to all commands. They can be set using environment
|
|
variables or flags.
|
|
|
|
--allow-redirects bool, $CODER_ALLOW_REDIRECTS
|
|
Follow HTTP redirects from the server instead of returning an error.
|
|
Following redirects may alter the request method and/or drop its body.
|
|
|
|
--client-tls-ca-file string, $CODER_CLIENT_TLS_CA_FILE
|
|
Path to a CA certificate file to trust for API and DERP connections.
|
|
|
|
--client-tls-cert-file string, $CODER_CLIENT_TLS_CERT_FILE
|
|
Path to a client certificate file for mTLS authentication with API and
|
|
DERP. Requires --client-tls-key-file.
|
|
|
|
--client-tls-key-file string, $CODER_CLIENT_TLS_KEY_FILE
|
|
Path to a client private key file for mTLS authentication with API and
|
|
DERP. Requires --client-tls-cert-file.
|
|
|
|
--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.
|
|
|
|
--flight-recorder-size int, $CODER_FLIGHT_RECORDER_SIZE (default: 10)
|
|
Number of log entries below the current log level to keep in memory
|
|
and emit on errors. Set to 0 to disable the flight recorder.
|
|
|
|
--force-tty bool, $CODER_FORCE_TTY
|
|
Force the use of a TTY.
|
|
|
|
--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. If a header value is a JWT, it will be refreshed based on
|
|
the value in its `exp` field.
|
|
|
|
--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.
|
|
|
|
--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
|
|
Enable verbose output.
|
|
|
|
———
|
|
Report bugs and request features at https://github.com/coder/coder/issues/new
|