`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._
1.9 KiB
Generated
1.9 KiB
Generated
title, description
| title | description |
|---|---|
| `coder workspace-proxy` | Workspace proxies provide low-latency experiences for geo-distributed teams. |
Workspace proxies provide low-latency experiences for geo-distributed teams.
Aliases:
- wsproxy
Usage
coder workspace-proxy
Description
Workspace proxies provide low-latency experiences for geo-distributed teams. It will act as a connection gateway to your workspace. Best used if Coder and your workspace are deployed in different regions.
Subcommands
| Name | Purpose |
|---|---|
server |
Start a workspace proxy server |
create |
Create a workspace proxy |
delete |
Delete a workspace proxy |
ls |
List all workspace proxies |
edit |
Edit a workspace proxy |
regenerate-token |
Regenerate a workspace proxy authentication token. This will invalidate the existing authentication token. |