Files
coder/docs/reference/cli/workspace-proxy/create.md
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

76 lines
2.2 KiB
Markdown
Generated

---
# Code generated by make gen. DO NOT EDIT.
title: "`coder workspace-proxy create`"
description: Create a workspace proxy
---
<!-- DO NOT EDIT | GENERATED CONTENT -->
Create a workspace proxy
## Usage
```console
coder workspace-proxy create [flags]
```
## Options
### --only-token
| | |
|------|-------------------|
| Type | <code>bool</code> |
Only print the token. This is useful for scripting.
### -c, --column
| | |
|---------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Type | <code>[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\|proxy token]</code> |
| Default | <code>name,url,proxy token</code> |
Columns to display in table output.
### -o, --output
| | |
|---------|--------------------------------|
| Type | <code>text\|json\|table</code> |
| Default | <code>text</code> |
Output format.
### --name
| | |
|------|---------------------|
| Type | <code>string</code> |
Name of the proxy. This is used to identify the proxy.
### --display-name
| | |
|------|---------------------|
| Type | <code>string</code> |
Display name of the proxy. If omitted, the name is reused as the display name.
### --icon
| | |
|------|---------------------|
| Type | <code>string</code> |
Display icon of the proxy.
### --no-prompt
| | |
|------|-------------------|
| Type | <code>bool</code> |
Disable all input prompting, and fail if any required flags are missing.