Files
coder/enterprise/cli/testdata/coder_workspace-proxy_edit_--help.golden
T
Nick Vigilante 3baeaceb1d feat: show coder workspace-proxy in CLI help and reference docs (#30146)
`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._
2026-09-30 12:39:06 -04:00

27 lines
787 B
Plaintext

coder v0.0.0-devel
USAGE:
coder workspace-proxy edit [flags] <name|id>
Edit a workspace proxy
OPTIONS:
-c, --column [id|name|display name|icon url|healthy|url|wildcard hostname|derp enabled|derp only|proxy status|proxy report|proxy checked at|created at|updated at|deleted|version] (default: name,url)
Columns to display in table output.
--display-name string
(Optional) Display name of the proxy. A more human friendly name to be
displayed.
--icon string
(Optional) Display icon of the proxy.
--name string
(Optional) Name of the proxy. This is used to identify the proxy.
-o, --output text|json|table (default: text)
Output format.
———
Run `coder --help` for a list of global options.