Files
coder/docs/manifest/generated/cli.json
Nick Vigilante d187dea338 docs: end every page description with a period and lint for it (#30863)
## Summary

Page descriptions in the docs were inconsistent about ending with a
period. This makes every page description end with one and adds a lint
so it stays that way.

A page description can come from three places, and the docs site reads
front matter first and falls back to the manifest:

- the hand-written YAML sidebar sources under `docs/manifest/`
(including `children_from` overlays),
- the generated fragments (`docs/manifest/generated/cli.json`,
`rest-api.json`), compiled into `docs/manifest.json`,
- a page's own front matter (today only the generated CLI and API
reference pages carry one).

The check covers all three. For the CLI, the description comes from each
command's `Short`, which stays unpunctuated by CLI-help convention, so
`clidocgen` adds the period when it writes the docs description instead
of changing 120 `Short` strings and the CLI golden files.

## What the lint checks

`make lint/docs-manifest` (`docsmanifestgen check`, already part of
`make lint` in CI) now fails when a non-empty description doesn't end
with `.`. No description in the tree ends with `?` or `!`, so the rule
allows only a period. Errors name the source file, the sidebar
breadcrumb, and the description, for example:

```
install/plan/sizing.yml: Install > Plan your deployment > Coder Validated Architecture > Up to 1,000 users: description must end with a period: "Hardware specifications and architecture guidance for Coder deployments that support up to 1,000 users"
generated/api.json: General: description must end with a period: "General endpoints"
reference/cli/ping.md: Reference > Command Line > `ping`: front matter description must end with a period: "Ping a workspace"
```

The style guide's page-description rule now lists the requirement and
cites the checker, and `styleclaims` recognises
`scripts/docsmanifestgen` so the coverage table counts it as
tool-checked.

## Count of descriptions fixed

147 descriptions in `docs/manifest.json`:

- 27 hand-written descriptions in 15 sidebar source files,
- 120 generated CLI descriptions, which also update the front matter of
120 CLI reference pages.

The REST API descriptions already ended with a period. No description is
otherwise reworded.

## Testing

- New table cases in `scripts/docgenenv` (section route, child route,
overlay, generated fragment, front matter, and a `?` ending) and
`scripts/clidocgen`, written first and failing before the change.
- `docsmanifestgen check` on the unfixed tree reported the 27 source
descriptions; after the fixes and regeneration it passes.
- `go test ./scripts/docgenenv/ ./scripts/clidocgen/
./scripts/docsmanifestgen/ ./scripts/styleclaims/
./scripts/apidocgen/...`
- `golangci-lint run` on the changed packages, `pnpm run check-docs`,
`go run ./scripts/styleclaims`, `scripts/check_emdash.sh`, and
`docsmanifestgen fmt` (no changes).

Linear: [DOCS-1304](https://linear.app/codercom/issue/DOCS-1304)

---

🤖 Built with AI assistance.
2026-10-20 18:51:44 -04:00

949 lines
26 KiB
JSON
Generated

[
{
"title": "`agent-firewall`",
"description": "Network isolation tool for monitoring and restricting HTTP/HTTPS requests.",
"path": "reference/cli/agent-firewall.md"
},
{
"title": "`ai-gateway`",
"description": "Manage AI Gateway.",
"path": "reference/cli/ai-gateway/index.md",
"children": [
{
"title": "`keys`",
"description": "Manage AI Gateway keys.",
"path": "reference/cli/ai-gateway/keys/index.md",
"children": [
{
"title": "`create`",
"description": "Create an AI Gateway key.",
"path": "reference/cli/ai-gateway/keys/create.md"
},
{
"title": "`delete`",
"description": "Delete an AI Gateway key.",
"path": "reference/cli/ai-gateway/keys/delete.md"
},
{
"title": "`list`",
"description": "List AI Gateway keys.",
"path": "reference/cli/ai-gateway/keys/list.md"
}
]
},
{
"title": "`start`",
"description": "Run a standalone AI Gateway server.",
"path": "reference/cli/ai-gateway/start.md"
}
]
},
{
"title": "`autoupdate`",
"description": "Toggle auto-update policy for a workspace.",
"path": "reference/cli/autoupdate.md"
},
{
"title": "`completion`",
"description": "Install or update shell completion scripts for the detected or chosen shell.",
"path": "reference/cli/completion.md"
},
{
"title": "`config-ssh`",
"description": "Add an SSH Host entry for your workspaces \"ssh workspace.coder\".",
"path": "reference/cli/config-ssh.md"
},
{
"title": "`create`",
"description": "Create a workspace.",
"path": "reference/cli/create.md"
},
{
"title": "`delete`",
"description": "Delete a workspace.",
"path": "reference/cli/delete.md"
},
{
"title": "`dotfiles`",
"description": "Personalize your workspace by applying a canonical dotfiles repository.",
"path": "reference/cli/dotfiles.md"
},
{
"title": "`external-auth`",
"description": "Manage external authentication.",
"path": "reference/cli/external-auth/index.md",
"children": [
{
"title": "`access-token`",
"description": "Print auth for an external provider.",
"path": "reference/cli/external-auth/access-token.md"
}
]
},
{
"title": "`external-workspaces`",
"description": "Create or manage external workspaces.",
"path": "reference/cli/external-workspaces/index.md",
"children": [
{
"title": "`agent-instructions`",
"description": "Get the instructions for an external agent.",
"path": "reference/cli/external-workspaces/agent-instructions.md"
},
{
"title": "`create`",
"description": "Create a new external workspace.",
"path": "reference/cli/external-workspaces/create.md"
},
{
"title": "`list`",
"description": "List external workspaces.",
"path": "reference/cli/external-workspaces/list.md"
}
]
},
{
"title": "`favorite`",
"description": "Add a workspace to your favorites.",
"path": "reference/cli/favorite.md"
},
{
"title": "`features`",
"description": "List license features and entitlements.",
"path": "reference/cli/features/index.md",
"children": [
{
"title": "`list`",
"path": "reference/cli/features/list.md"
}
]
},
{
"title": "`groups`",
"description": "Manage groups.",
"path": "reference/cli/groups/index.md",
"children": [
{
"title": "`create`",
"description": "Create a user group.",
"path": "reference/cli/groups/create.md"
},
{
"title": "`delete`",
"description": "Delete a user group.",
"path": "reference/cli/groups/delete.md"
},
{
"title": "`edit`",
"description": "Edit a user group.",
"path": "reference/cli/groups/edit.md"
},
{
"title": "`list`",
"description": "List user groups.",
"path": "reference/cli/groups/list.md"
}
]
},
{
"title": "`licenses`",
"description": "Add, delete, and list licenses.",
"path": "reference/cli/licenses/index.md",
"children": [
{
"title": "`add`",
"description": "Add license to Coder deployment.",
"path": "reference/cli/licenses/add.md"
},
{
"title": "`delete`",
"description": "Delete license by ID.",
"path": "reference/cli/licenses/delete.md"
},
{
"title": "`list`",
"description": "List licenses (including expired).",
"path": "reference/cli/licenses/list.md"
}
]
},
{
"title": "`list`",
"description": "List workspaces.",
"path": "reference/cli/list.md"
},
{
"title": "`login`",
"description": "Authenticate with Coder deployment.",
"path": "reference/cli/login/index.md",
"children": [
{
"title": "`token`",
"description": "Print the current session token.",
"path": "reference/cli/login/token.md"
}
]
},
{
"title": "`logout`",
"description": "Unauthenticate your local session.",
"path": "reference/cli/logout.md"
},
{
"title": "`logs`",
"description": "View logs for a workspace.",
"path": "reference/cli/logs.md"
},
{
"title": "`netcheck`",
"description": "Print network debug information for DERP and STUN.",
"path": "reference/cli/netcheck.md"
},
{
"title": "`notifications`",
"description": "Manage Coder notifications.",
"path": "reference/cli/notifications/index.md",
"children": [
{
"title": "`custom`",
"description": "Send a custom notification.",
"path": "reference/cli/notifications/custom.md"
},
{
"title": "`pause`",
"description": "Pause notifications.",
"path": "reference/cli/notifications/pause.md"
},
{
"title": "`resume`",
"description": "Resume notifications.",
"path": "reference/cli/notifications/resume.md"
},
{
"title": "`test`",
"description": "Send a test notification.",
"path": "reference/cli/notifications/test.md"
}
]
},
{
"title": "`oauth2-provider`",
"description": "Manage Coder OAuth2 provider settings.",
"path": "reference/cli/oauth2-provider/index.md",
"children": [
{
"title": "`dcr`",
"description": "Manage OAuth2 dynamic client registration (RFC 7591).",
"path": "reference/cli/oauth2-provider/dcr/index.md",
"children": [
{
"title": "`disable`",
"description": "Disable OAuth2 dynamic client registration.",
"path": "reference/cli/oauth2-provider/dcr/disable.md"
},
{
"title": "`enable`",
"description": "Enable OAuth2 dynamic client registration.",
"path": "reference/cli/oauth2-provider/dcr/enable.md"
}
]
}
]
},
{
"title": "`open`",
"description": "Open a workspace.",
"path": "reference/cli/open/index.md",
"children": [
{
"title": "`app`",
"description": "Open a workspace application.",
"path": "reference/cli/open/app.md"
},
{
"title": "`vscode`",
"description": "Open a workspace in VS Code Desktop.",
"path": "reference/cli/open/vscode.md"
}
]
},
{
"title": "`organizations`",
"description": "Organization related commands.",
"path": "reference/cli/organizations/index.md",
"children": [
{
"title": "`create`",
"description": "Create a new organization.",
"path": "reference/cli/organizations/create.md"
},
{
"title": "`delete`",
"description": "Delete an organization.",
"path": "reference/cli/organizations/delete.md"
},
{
"title": "`edit`",
"description": "Edit organization settings.",
"path": "reference/cli/organizations/edit.md"
},
{
"title": "`list`",
"description": "List all organizations.",
"path": "reference/cli/organizations/list.md"
},
{
"title": "`members`",
"description": "Manage organization members.",
"path": "reference/cli/organizations/members/index.md",
"children": [
{
"title": "`add`",
"description": "Add a new member to the current organization.",
"path": "reference/cli/organizations/members/add.md"
},
{
"title": "`edit-roles`",
"description": "Edit organization member's roles.",
"path": "reference/cli/organizations/members/edit-roles.md"
},
{
"title": "`list`",
"description": "List all organization members.",
"path": "reference/cli/organizations/members/list.md"
},
{
"title": "`remove`",
"description": "Remove a new member to the current organization.",
"path": "reference/cli/organizations/members/remove.md"
}
]
},
{
"title": "`roles`",
"description": "Manage organization roles.",
"path": "reference/cli/organizations/roles/index.md",
"children": [
{
"title": "`create`",
"description": "Create a new organization custom role.",
"path": "reference/cli/organizations/roles/create.md"
},
{
"title": "`show`",
"description": "Show role(s).",
"path": "reference/cli/organizations/roles/show.md"
},
{
"title": "`update`",
"description": "Update an organization custom role.",
"path": "reference/cli/organizations/roles/update.md"
}
]
},
{
"title": "`settings`",
"description": "Manage organization settings.",
"path": "reference/cli/organizations/settings/index.md",
"children": [
{
"title": "`set`",
"description": "Update specified organization setting.",
"path": "reference/cli/organizations/settings/set/index.md",
"children": [
{
"title": "`group-sync`",
"description": "Group sync settings to sync groups from an IdP.",
"path": "reference/cli/organizations/settings/set/group-sync.md"
},
{
"title": "`organization-sync`",
"description": "Organization sync settings to sync organization memberships from an IdP.",
"path": "reference/cli/organizations/settings/set/organization-sync.md"
},
{
"title": "`role-sync`",
"description": "Role sync settings to sync organization roles from an IdP.",
"path": "reference/cli/organizations/settings/set/role-sync.md"
},
{
"title": "`workspace-sharing`",
"description": "Workspace sharing settings for the organization.",
"path": "reference/cli/organizations/settings/set/workspace-sharing.md"
}
]
},
{
"title": "`show`",
"description": "Outputs specified organization setting.",
"path": "reference/cli/organizations/settings/show/index.md",
"children": [
{
"title": "`group-sync`",
"description": "Group sync settings to sync groups from an IdP.",
"path": "reference/cli/organizations/settings/show/group-sync.md"
},
{
"title": "`organization-sync`",
"description": "Organization sync settings to sync organization memberships from an IdP.",
"path": "reference/cli/organizations/settings/show/organization-sync.md"
},
{
"title": "`role-sync`",
"description": "Role sync settings to sync organization roles from an IdP.",
"path": "reference/cli/organizations/settings/show/role-sync.md"
},
{
"title": "`workspace-sharing`",
"description": "Workspace sharing settings for the organization.",
"path": "reference/cli/organizations/settings/show/workspace-sharing.md"
}
]
}
]
},
{
"title": "`show`",
"description": "Show the organization. Using \"selected\" will show the selected organization from the \"--org\" flag. Using \"me\" will show all organizations you are a member of.",
"path": "reference/cli/organizations/show.md"
}
]
},
{
"title": "`ping`",
"description": "Ping a workspace.",
"path": "reference/cli/ping.md"
},
{
"title": "`port-forward`",
"description": "Forward ports from a workspace to the local machine. For reverse port forwarding, use \"coder ssh -R\".",
"path": "reference/cli/port-forward.md"
},
{
"title": "`prebuilds`",
"description": "Manage Coder prebuilds.",
"path": "reference/cli/prebuilds/index.md",
"children": [
{
"title": "`pause`",
"description": "Pause prebuilds.",
"path": "reference/cli/prebuilds/pause.md"
},
{
"title": "`resume`",
"description": "Resume prebuilds.",
"path": "reference/cli/prebuilds/resume.md"
}
]
},
{
"title": "`provisioner`",
"description": "View and manage provisioner daemons and jobs.",
"path": "reference/cli/provisioner/index.md",
"children": [
{
"title": "`jobs`",
"description": "View and manage provisioner jobs.",
"path": "reference/cli/provisioner/jobs/index.md",
"children": [
{
"title": "`cancel`",
"description": "Cancel a provisioner job.",
"path": "reference/cli/provisioner/jobs/cancel.md"
},
{
"title": "`list`",
"description": "List provisioner jobs.",
"path": "reference/cli/provisioner/jobs/list.md"
}
]
},
{
"title": "`keys`",
"description": "Manage provisioner keys.",
"path": "reference/cli/provisioner/keys/index.md",
"children": [
{
"title": "`create`",
"description": "Create a new provisioner key.",
"path": "reference/cli/provisioner/keys/create.md"
},
{
"title": "`delete`",
"description": "Delete a provisioner key.",
"path": "reference/cli/provisioner/keys/delete.md"
},
{
"title": "`list`",
"description": "List provisioner keys in an organization.",
"path": "reference/cli/provisioner/keys/list.md"
}
]
},
{
"title": "`list`",
"description": "List provisioner daemons in an organization.",
"path": "reference/cli/provisioner/list.md"
},
{
"title": "`start`",
"description": "Run a provisioner daemon.",
"path": "reference/cli/provisioner/start.md"
}
]
},
{
"title": "`publickey`",
"description": "Output your Coder public key used for Git operations.",
"path": "reference/cli/publickey.md"
},
{
"title": "`rename`",
"description": "Rename a workspace.",
"path": "reference/cli/rename.md"
},
{
"title": "`reset-password`",
"description": "Directly connect to the database to reset a user's password.",
"path": "reference/cli/reset-password.md"
},
{
"title": "`restart`",
"description": "Restart a workspace.",
"path": "reference/cli/restart.md"
},
{
"title": "`schedule`",
"description": "Schedule automated start and stop times for workspaces.",
"path": "reference/cli/schedule/index.md",
"children": [
{
"title": "`extend`",
"description": "Extend the stop time of a currently running workspace instance.",
"path": "reference/cli/schedule/extend.md"
},
{
"title": "`show`",
"description": "Show workspace schedules.",
"path": "reference/cli/schedule/show.md"
},
{
"title": "`start`",
"description": "Edit workspace start schedule.",
"path": "reference/cli/schedule/start.md"
},
{
"title": "`stop`",
"description": "Edit workspace stop schedule.",
"path": "reference/cli/schedule/stop.md"
}
]
},
{
"title": "`secret`",
"description": "Manage secrets.",
"path": "reference/cli/secret/index.md",
"children": [
{
"title": "`create`",
"description": "Create a secret.",
"path": "reference/cli/secret/create.md"
},
{
"title": "`delete`",
"description": "Delete a secret.",
"path": "reference/cli/secret/delete.md"
},
{
"title": "`disable`",
"description": "Disable a secret without removing it.",
"path": "reference/cli/secret/disable.md"
},
{
"title": "`enable`",
"description": "Enable a secret so it is injected into workspaces.",
"path": "reference/cli/secret/enable.md"
},
{
"title": "`import`",
"description": "Import secrets from a file.",
"path": "reference/cli/secret/import.md"
},
{
"title": "`list`",
"description": "List secrets, or show one by name.",
"path": "reference/cli/secret/list.md"
},
{
"title": "`update`",
"description": "Update a secret.",
"path": "reference/cli/secret/update.md"
}
]
},
{
"title": "`server`",
"description": "Start a Coder server.",
"path": "reference/cli/server/index.md",
"children": [
{
"title": "`create-admin-user`",
"description": "Create a new admin user with the given username, email and password and adds it to every organization.",
"path": "reference/cli/server/create-admin-user.md"
},
{
"title": "`dbcrypt`",
"description": "Manage database encryption.",
"path": "reference/cli/server/dbcrypt/index.md",
"children": [
{
"title": "`decrypt`",
"description": "Decrypt a previously encrypted database.",
"path": "reference/cli/server/dbcrypt/decrypt.md"
},
{
"title": "`delete`",
"description": "Delete all encrypted data from the database. THIS IS A DESTRUCTIVE OPERATION.",
"path": "reference/cli/server/dbcrypt/delete.md"
},
{
"title": "`rotate`",
"description": "Rotate database encryption keys.",
"path": "reference/cli/server/dbcrypt/rotate.md"
}
]
},
{
"title": "`fix-oidc-links`",
"description": "Reset OIDC linked IDs that do not match the expected issuer, allowing users to re-authenticate.",
"path": "reference/cli/server/fix-oidc-links.md"
},
{
"title": "`postgres-builtin-serve`",
"description": "Run the built-in PostgreSQL deployment.",
"path": "reference/cli/server/postgres-builtin-serve.md"
},
{
"title": "`postgres-builtin-url`",
"description": "Output the connection URL for the built-in PostgreSQL deployment.",
"path": "reference/cli/server/postgres-builtin-url.md"
}
]
},
{
"title": "`sharing`",
"description": "Commands for managing shared workspaces.",
"path": "reference/cli/sharing/index.md",
"children": [
{
"title": "`add`",
"description": "Share a workspace with a user or group.",
"path": "reference/cli/sharing/add.md"
},
{
"title": "`remove`",
"description": "Remove shared access for users or groups from a workspace.",
"path": "reference/cli/sharing/remove.md"
},
{
"title": "`status`",
"description": "List all users and groups the given Workspace is shared with.",
"path": "reference/cli/sharing/status.md"
}
]
},
{
"title": "`show`",
"description": "Display details of a workspace's resources and agents.",
"path": "reference/cli/show.md"
},
{
"title": "`speedtest`",
"description": "Run upload and download tests from your machine to a workspace.",
"path": "reference/cli/speedtest.md"
},
{
"title": "`ssh`",
"description": "Start a shell into a workspace or run a command.",
"path": "reference/cli/ssh.md"
},
{
"title": "`start`",
"description": "Start a workspace.",
"path": "reference/cli/start.md"
},
{
"title": "`stat`",
"description": "Show resource usage for the current workspace.",
"path": "reference/cli/stat/index.md",
"children": [
{
"title": "`cpu`",
"description": "Show CPU usage, in cores.",
"path": "reference/cli/stat/cpu.md"
},
{
"title": "`disk`",
"description": "Show disk usage, in gigabytes.",
"path": "reference/cli/stat/disk.md"
},
{
"title": "`mem`",
"description": "Show memory usage, in gigabytes.",
"path": "reference/cli/stat/mem.md"
}
]
},
{
"title": "`state`",
"description": "Manually manage Terraform state to fix broken workspaces.",
"path": "reference/cli/state/index.md",
"children": [
{
"title": "`pull`",
"description": "Pull a Terraform state file from a workspace.",
"path": "reference/cli/state/pull.md"
},
{
"title": "`push`",
"description": "Push a Terraform state file to a workspace.",
"path": "reference/cli/state/push.md"
}
]
},
{
"title": "`stop`",
"description": "Stop a workspace.",
"path": "reference/cli/stop.md"
},
{
"title": "`support`",
"description": "Commands for troubleshooting issues with a Coder deployment.",
"path": "reference/cli/support/index.md",
"children": [
{
"title": "`bundle`",
"description": "Generate a support bundle to troubleshoot issues connecting to a workspace.",
"path": "reference/cli/support/bundle.md"
}
]
},
{
"title": "`templates`",
"description": "Manage templates.",
"path": "reference/cli/templates/index.md",
"children": [
{
"title": "`archive`",
"description": "Archive unused or failed template versions from a given template(s).",
"path": "reference/cli/templates/archive.md"
},
{
"title": "`create`",
"description": "DEPRECATED: Create a template from the current directory or as specified by flag.",
"path": "reference/cli/templates/create.md"
},
{
"title": "`delete`",
"description": "Delete templates.",
"path": "reference/cli/templates/delete.md"
},
{
"title": "`edit`",
"description": "Edit the metadata of a template by name.",
"path": "reference/cli/templates/edit.md"
},
{
"title": "`init`",
"description": "Get started with a templated template.",
"path": "reference/cli/templates/init.md"
},
{
"title": "`list`",
"description": "List all the templates available for the organization.",
"path": "reference/cli/templates/list.md"
},
{
"title": "`presets`",
"description": "Manage presets of the specified template.",
"path": "reference/cli/templates/presets/index.md",
"children": [
{
"title": "`list`",
"description": "List all presets of the specified template. Defaults to the active template version.",
"path": "reference/cli/templates/presets/list.md"
}
]
},
{
"title": "`pull`",
"description": "Download the active, latest, or specified version of a template to a path.",
"path": "reference/cli/templates/pull.md"
},
{
"title": "`push`",
"description": "Create or update a template from the current directory or as specified by flag.",
"path": "reference/cli/templates/push.md"
},
{
"title": "`versions`",
"description": "Manage different versions of the specified template.",
"path": "reference/cli/templates/versions/index.md",
"children": [
{
"title": "`archive`",
"description": "Archive a template version(s).",
"path": "reference/cli/templates/versions/archive.md"
},
{
"title": "`list`",
"description": "List all the versions of the specified template.",
"path": "reference/cli/templates/versions/list.md"
},
{
"title": "`promote`",
"description": "Promote a template version to active.",
"path": "reference/cli/templates/versions/promote.md"
},
{
"title": "`unarchive`",
"description": "Unarchive a template version(s).",
"path": "reference/cli/templates/versions/unarchive.md"
}
]
}
]
},
{
"title": "`tokens`",
"description": "Manage personal access tokens.",
"path": "reference/cli/tokens/index.md",
"children": [
{
"title": "`create`",
"description": "Create a token.",
"path": "reference/cli/tokens/create.md"
},
{
"title": "`list`",
"description": "List tokens.",
"path": "reference/cli/tokens/list.md"
},
{
"title": "`remove`",
"description": "Expire or delete a token.",
"path": "reference/cli/tokens/remove.md"
},
{
"title": "`view`",
"description": "Display detailed information about a token.",
"path": "reference/cli/tokens/view.md"
}
]
},
{
"title": "`unfavorite`",
"description": "Remove a workspace from your favorites.",
"path": "reference/cli/unfavorite.md"
},
{
"title": "`update`",
"description": "Will update and start a given workspace if it is out of date. If the workspace is already running, it will be stopped first.",
"path": "reference/cli/update.md"
},
{
"title": "`users`",
"description": "Manage users.",
"path": "reference/cli/users/index.md",
"children": [
{
"title": "`activate`",
"description": "Update a user's status to 'active'. Active users can fully interact with the platform.",
"path": "reference/cli/users/activate.md"
},
{
"title": "`create`",
"description": "Create a new user.",
"path": "reference/cli/users/create.md"
},
{
"title": "`delete`",
"description": "Delete a user by username or user_id.",
"path": "reference/cli/users/delete.md"
},
{
"title": "`edit-roles`",
"description": "Edit a user's roles by username or id.",
"path": "reference/cli/users/edit-roles.md"
},
{
"title": "`list`",
"description": "Prints the list of users.",
"path": "reference/cli/users/list.md"
},
{
"title": "`oidc-claims`",
"description": "Display the OIDC claims for the authenticated user.",
"path": "reference/cli/users/oidc-claims.md"
},
{
"title": "`show`",
"description": "Show a single user. Use 'me' to indicate the currently authenticated user.",
"path": "reference/cli/users/show.md"
},
{
"title": "`suspend`",
"description": "Update a user's status to 'suspended'. A suspended user cannot log into the platform. Suspending a user stops their running workspaces; activating the user again does not restart them.",
"path": "reference/cli/users/suspend.md"
}
]
},
{
"title": "`version`",
"description": "Show coder version.",
"path": "reference/cli/version.md"
},
{
"title": "`whoami`",
"description": "Fetch authenticated user info for Coder deployment.",
"path": "reference/cli/whoami.md"
},
{
"title": "`workspace-proxy`",
"description": "Workspace proxies provide low-latency experiences for geo-distributed teams.",
"path": "reference/cli/workspace-proxy/index.md",
"children": [
{
"title": "`create`",
"description": "Create a workspace proxy.",
"path": "reference/cli/workspace-proxy/create.md"
},
{
"title": "`delete`",
"description": "Delete a workspace proxy.",
"path": "reference/cli/workspace-proxy/delete.md"
},
{
"title": "`edit`",
"description": "Edit a workspace proxy.",
"path": "reference/cli/workspace-proxy/edit.md"
},
{
"title": "`ls`",
"description": "List all workspace proxies.",
"path": "reference/cli/workspace-proxy/ls.md"
},
{
"title": "`regenerate-token`",
"description": "Regenerate a workspace proxy authentication token. This will invalidate the existing authentication token.",
"path": "reference/cli/workspace-proxy/regenerate-token.md"
},
{
"title": "`server`",
"description": "Start a workspace proxy server.",
"path": "reference/cli/workspace-proxy/server.md"
}
]
}
]