feat: make CLI/API doc generators emit front-matter metadata (Phase 2) (#27246)

## Summary

Phase 2 of the H1 → front-matter migration (`DOCS-483`; parent
`DOCS-477`). Makes the two reference-doc generators emit per-page
metadata as YAML front matter instead of a leading `# H1`, so generated
pages are self-describing and `make gen` stops reverting migrated pages
(Phase 3).

Phase 1 (`DOCS-482`) made the coder.com renderers prefer a front-matter
`title` (manifest fallback).

> [!NOTE]
> Rebased onto `main` and fully regenerated, and updated across two
rounds of Coder Agents Review — see **Review follow-ups** below.

## Changes

- **`scripts/clidocgen/command.tpl` + `gen.go` + `main.go`** — front
matter now carries `title` (from `fullName`) and `description` (from the
command's `Short`), and the leading `# H1` is dropped. The CLI index
page's front matter is taken from the manifest `Command Line` route
(title/description/icon_path).
- **`scripts/apidocgen/postprocess/main.go`** — reads the manifest and,
at write time, injects front matter carrying each section's `title` plus
any curated `description`, `state`, and `icon_path`. The API index
page's front matter is taken from the manifest `REST API` route.
- **`scripts/docgenenv`** (new shared code) — one `YAMLScalar`
front-matter escaper, one `Route`/`Manifest` schema +
`LoadManifest`/`FindRoute`, and one `FrontMatter(Route)` emitter, all
imported by both generators (no duplicated helpers, types, or emitters).
- Regenerated all **166 CLI + 31 API** reference pages.

### Metadata → front matter, and what stays in the manifest

Every *per-page* manifest field is mirrored into the page's front
matter: `title`, `description`, `state`, `icon_path`. The **structural**
fields stay in `manifest.json`:

- `children` — the nav tree (explicitly out of scope).
- `path` — the manifest's pointer to the file; a page carrying its own
path is redundant/error-prone, so it's treated like `children`.

The fields are **duplicated** into front matter and **`manifest.json` is
left unchanged**, so this is a **no-op for rendering today** (coder.com
strips front matter for `llms`, and Algolia + the renderer read only
`title`). Removing the fields from the manifest is the natural
follow-up, gated on the renderer reading them from front matter first.

### Why the API side changes the postprocessor, not the `.dot` templates

The issue text suggested editing
`scripts/apidocgen/markdown-template/*`. I deliberately did **not**,
because the postprocessor derives each page's **filename, section title,
and manifest route** from the leading `# {name}` line
(`extractSectionName`). Emitting front matter from the template would
break that extraction. Instead the widdershins templates still emit `#
{name}`, the postprocessor reads it (and now verifies it), and then
swaps the heading for a front-matter block as each section is written.

## Review follow-ups (Coder Agents Review)

### Round 1 — addressed in `e53d5e03` (all threads resolved)

- **CRF-1 / CRF-4** — de-duplicated the escaper and the
`route`/`manifest` schema + traversal into `scripts/docgenenv` (shared
by both generators).
- **CRF-2** — `YAMLScalar` now quotes YAML-reserved scalars
(`true/false/null/…`, numbers); no current value is affected.
- **CRF-3** — added unit tests: a `YAMLScalar` round-trip, `FindRoute`,
and `prependFrontMatter`.
- **CRF-5** — the CLI and API **index** pages now mirror their manifest
route's title/description/icon_path instead of a hardcoded
`coder`/`API`, fixing a rendered-heading regression (`REST API`/`Command
Line` were being overwritten).
- **CRF-6** — dropped the dead `#login` anchor in
`docs/support/support-bundle.md` (the migrated `login.md` no longer
mints that heading anchor).
- **CRF-7 / CRF-8 / CRF-11** — renamed to `prependFrontMatter`, switched
to `bytes.Cut`, and it now strips the first line only when it is the `#
{name}` heading (`extractSectionName` errors otherwise).
- **CRF-9** — removed the orphan `docs/reference/api/chat.md` (not in
the manifest, not linked; the real page is `chats.md`).
- **CRF-10** — the metadata read and the manifest rewrite now share one
`FindRoute` traversal.
- **CRF-13** — moot under squash-merge; this branch is a single
scopeless commit.
- **CRF-15** — the pre-existing `sort.Slice`/`slices.IsSorted`
comparator is left as-is per the review (out of scope; safe today
because section names are unique).

### Round 2 — addressed in `ee796e7107` (all threads resolved)

- **CRF-16** (P1) — removed three em-dashes from new doc comments (the
only `make lint` failure on the prior head); the emdash gate is green.
- **CRF-17 / CRF-18** — unified front-matter emission into one shared
`docgenenv.FrontMatter(Route)`, used by the API postprocessor directly
and by `command.tpl` via a `frontMatter` template func. This retires the
hand-written template YAML and the
`indexTitle`/`indexDescription`/`indexIconPath` closures, so a new
front-matter field is wired in one place, and it gives the CLI index the
`state` arm it previously lacked. Verified byte-identical: a full CLI +
API regen produces zero page changes.
- **CRF-19** — CLI child sort switched to `slices.SortFunc` +
`cmp.Compare` (typed comparator).
- **CRF-20** — reworded the `prependFrontMatter` comment:
`extractSectionName`'s fail-fast is the load-bearing guard; the prefix
check is a defensive backstop.
- **CRF-21** — added `icon_path`/`state` coverage in `docgenenv`'s
`TestFrontMatter/AllFields` (the branch the index page relies on,
previously at 0%).
- **CRF-22** — `YAMLScalar` no longer emits a trailing-space value as a
bare scalar (YAML strips it on read, so it would not round-trip); added
test coverage.
- **CRF-24** — the shared emitter removed the duplicated `cliIndexRoute`
doc comment; the rationale now lives in one place.
- **CRF-23** (Phase 3, out of scope here) — noted: the API generator
wipes and regenerates `reference/api/` from the manifest, so removing
curated metadata from the manifest in Phase 3 needs another source first
(a generator that preserves existing front matter, or metadata carried
alongside the swagger annotations).
- **Process (Mafu-san)** — the verification set below now leads with
`make lint`, the mandatory CI gate that the earlier list omitted.

## Cross-repo dependency

**Resolved — this PR no longer has a hard merge-ordering gate** (CRF-14
was right; the earlier "must merge after #968" note was stale).

The coder.com surfaces that would otherwise leak raw front matter from
`coder/coder` `main` are already front-matter-aware on merged PRs:

- **coder.com#964** (`DOCS-554`, llms-full.txt corpus + Algolia) —
**merged**.
- **coder.com#974** (`DOCS-574`, the `.md` proxy twin + `llms.txt` index
titles) — **merged**.

coder.com#968 (`DOCS-577`) was re-scoped to only the renderer
route-metadata generalization; it's a no-op on today's corpus and its
own description confirms the "deploy before the generators" constraint
no longer applies (that was driven by the llms corpus, now in #964).
Worth a final confirmation that #964/#974 are **deployed** before merge,
but there's no branch/PR ordering blocker left.

## Verification & evidence

AI was the primary author of this PR (see disclosure below); per the [AI
Contribution
Guidelines](https://coder.com/docs/about/contributing/AI_CONTRIBUTING)
here is manual verification.

- `make lint` (golangci-lint + the emdash gate) passes; `go build` / `go
vet` / `go test` are clean for the generators + `scripts/docgenenv`;
`pnpm check-docs` passes.
- `swagger.json`, `docs.go`, and `manifest.json` are **unchanged** —
metadata is duplicated into front matter; command/section names and
routes did not move.
- The diff is purely additive front matter
(`title`/`description`/`state`/`icon_path`) + the leading H1 removal; no
body reflow. A full CLI + API regen produces **zero** page changes
beyond the two index pages.

<details>
<summary>Terminal evidence</summary>

CLI `description` from the command's `Short` (`YAMLScalar` quotes when
needed, e.g. a `Short` with a colon):

```md
---
title: server
description: Start a Coder server
---
```

API pages inherit curated manifest metadata (only Agents/Chats have any
today):

```md
---
title: Chats
description: "REST endpoints for Coder Agents Chats API (programmatic agent sessions)."
state:
  - early access
---
```

Diff scope + "no body changes" proof (uses an explicit `base..HEAD`
range, so it actually tests the claim):

```
$ git diff --shortstat origin/main
 210 files changed, 1447 insertions(+), 344 deletions(-)
# = 166 CLI + 31 API reference pages + generators + scripts/docgenenv
# swagger.json / docs.go / manifest.json: NOT modified

# Every removed line under docs/reference is a leading "# H1"; nothing else:
$ git diff origin/main..HEAD -- docs/reference/ | grep '^-' | grep -v '^---' | grep -v '^-# '
(empty)

$ pnpm check-docs
Summary: 0 error(s)
```

</details>

Linear: DOCS-483

> This PR was created with AI assistance (Coder Agents).
This commit is contained in:
Nick Vigilante
2026-08-11 15:22:55 +00:00
committed by GitHub
parent 5febde0ebb
commit 0a7bb80a1e
218 changed files with 1941 additions and 352 deletions
+7 -1
View File
@@ -1,4 +1,10 @@
# Agents
---
# Code generated by make gen. DO NOT EDIT.
title: Agents
description: "REST endpoints for the workspace agent daemon (`coder_agent`)."
---
<!-- DO NOT EDIT | GENERATED CONTENT -->
Workspace agent endpoints. These power the workspace agent daemon defined by the `coder_agent` Terraform resource. This API is NOT the Coder Agents Chats API. For programmatic access to AI Coder Agents, see the Chats API.
+6 -1
View File
@@ -1,4 +1,9 @@
# AI Gateway
---
# Code generated by make gen. DO NOT EDIT.
title: AI Gateway
---
<!-- DO NOT EDIT | GENERATED CONTENT -->
## List AI Gateway clients
+6 -1
View File
@@ -1,4 +1,9 @@
# AI Providers
---
# Code generated by make gen. DO NOT EDIT.
title: AI Providers
---
<!-- DO NOT EDIT | GENERATED CONTENT -->
## List AI providers
+6 -1
View File
@@ -1,4 +1,9 @@
# Applications
---
# Code generated by make gen. DO NOT EDIT.
title: Applications
---
<!-- DO NOT EDIT | GENERATED CONTENT -->
## Redirect to URI with encrypted API key
+6 -1
View File
@@ -1,4 +1,9 @@
# Audit
---
# Code generated by make gen. DO NOT EDIT.
title: Audit
---
<!-- DO NOT EDIT | GENERATED CONTENT -->
## Get audit logs
+6 -1
View File
@@ -1,4 +1,9 @@
# Authentication
---
# Code generated by make gen. DO NOT EDIT.
title: Authentication
---
<!-- DO NOT EDIT | GENERATED CONTENT -->
Long-lived tokens can be generated to perform actions on behalf of your user account:
+6 -1
View File
@@ -1,4 +1,9 @@
# Authorization
---
# Code generated by make gen. DO NOT EDIT.
title: Authorization
---
<!-- DO NOT EDIT | GENERATED CONTENT -->
## List API key scopes
+6 -1
View File
@@ -1,4 +1,9 @@
# Builds
---
# Code generated by make gen. DO NOT EDIT.
title: Builds
---
<!-- DO NOT EDIT | GENERATED CONTENT -->
## Get workspace build by user, workspace name, and build number
-1
View File
@@ -1 +0,0 @@
# Chat
+9 -1
View File
@@ -1,4 +1,12 @@
# Chats
---
# Code generated by make gen. DO NOT EDIT.
title: Chats
description: "REST endpoints for Coder Agents Chats API (programmatic agent sessions)."
state:
- early access
---
<!-- DO NOT EDIT | GENERATED CONTENT -->
Programmatic API for Coder Agents (the user-facing "Coder Agents" / "Chats" product). Use these endpoints to create, list, and manage AI coding agent sessions.
+6 -1
View File
@@ -1,4 +1,9 @@
# Debug
---
# Code generated by make gen. DO NOT EDIT.
title: Debug
---
<!-- DO NOT EDIT | GENERATED CONTENT -->
## Debug Info Wireguard Coordinator
+6 -1
View File
@@ -1,4 +1,9 @@
# Enterprise
---
# Code generated by make gen. DO NOT EDIT.
title: Enterprise
---
<!-- DO NOT EDIT | GENERATED CONTENT -->
## OAuth2 authorization server metadata
+6 -1
View File
@@ -1,4 +1,9 @@
# Files
---
# Code generated by make gen. DO NOT EDIT.
title: Files
---
<!-- DO NOT EDIT | GENERATED CONTENT -->
## Upload file
+6 -1
View File
@@ -1,4 +1,9 @@
# General
---
# Code generated by make gen. DO NOT EDIT.
title: General
---
<!-- DO NOT EDIT | GENERATED CONTENT -->
## API root handler
+6 -1
View File
@@ -1,4 +1,9 @@
# Git
---
# Code generated by make gen. DO NOT EDIT.
title: Git
---
<!-- DO NOT EDIT | GENERATED CONTENT -->
## Get user external auths
+8 -1
View File
@@ -1,4 +1,11 @@
# API
---
# Code generated by make gen. DO NOT EDIT.
title: REST API
description: "Reference for the Coder REST API, including endpoints, authentication, and schemas."
icon_path: "./images/icons/api.svg"
---
<!-- DO NOT EDIT | GENERATED CONTENT -->
Get started with the Coder API:
+6 -1
View File
@@ -1,4 +1,9 @@
# InitScript
---
# Code generated by make gen. DO NOT EDIT.
title: InitScript
---
<!-- DO NOT EDIT | GENERATED CONTENT -->
## Get agent init script
+6 -1
View File
@@ -1,4 +1,9 @@
# Insights
---
# Code generated by make gen. DO NOT EDIT.
title: Insights
---
<!-- DO NOT EDIT | GENERATED CONTENT -->
## Get deployment DAUs
+6 -1
View File
@@ -1,4 +1,9 @@
# Members
---
# Code generated by make gen. DO NOT EDIT.
title: Members
---
<!-- DO NOT EDIT | GENERATED CONTENT -->
## List organization members
+6 -1
View File
@@ -1,4 +1,9 @@
# Notifications
---
# Code generated by make gen. DO NOT EDIT.
title: Notifications
---
<!-- DO NOT EDIT | GENERATED CONTENT -->
## Send a custom notification
+6 -1
View File
@@ -1,4 +1,9 @@
# Organizations
---
# Code generated by make gen. DO NOT EDIT.
title: Organizations
---
<!-- DO NOT EDIT | GENERATED CONTENT -->
## Get organizations
+6 -1
View File
@@ -1,4 +1,9 @@
# PortSharing
---
# Code generated by make gen. DO NOT EDIT.
title: PortSharing
---
<!-- DO NOT EDIT | GENERATED CONTENT -->
## Get workspace agent port shares
+6 -1
View File
@@ -1,4 +1,9 @@
# Prebuilds
---
# Code generated by make gen. DO NOT EDIT.
title: Prebuilds
---
<!-- DO NOT EDIT | GENERATED CONTENT -->
## Get prebuilds settings
+6 -1
View File
@@ -1,4 +1,9 @@
# Provisioning
---
# Code generated by make gen. DO NOT EDIT.
title: Provisioning
---
<!-- DO NOT EDIT | GENERATED CONTENT -->
## Get provisioner daemons
+6 -1
View File
@@ -1,4 +1,9 @@
# Schemas
---
# Code generated by make gen. DO NOT EDIT.
title: Schemas
---
<!-- DO NOT EDIT | GENERATED CONTENT -->
## agentsdk.AWSInstanceIdentityToken
+6 -1
View File
@@ -1,4 +1,9 @@
# Secrets
---
# Code generated by make gen. DO NOT EDIT.
title: Secrets
---
<!-- DO NOT EDIT | GENERATED CONTENT -->
## List user secrets
+6 -1
View File
@@ -1,4 +1,9 @@
# Tasks
---
# Code generated by make gen. DO NOT EDIT.
title: Tasks
---
<!-- DO NOT EDIT | GENERATED CONTENT -->
## List AI tasks
+6 -1
View File
@@ -1,4 +1,9 @@
# TemplateBuilder
---
# Code generated by make gen. DO NOT EDIT.
title: TemplateBuilder
---
<!-- DO NOT EDIT | GENERATED CONTENT -->
## List template builder base templates
+6 -1
View File
@@ -1,4 +1,9 @@
# Templates
---
# Code generated by make gen. DO NOT EDIT.
title: Templates
---
<!-- DO NOT EDIT | GENERATED CONTENT -->
## Get templates by organization
+6 -1
View File
@@ -1,4 +1,9 @@
# Users
---
# Code generated by make gen. DO NOT EDIT.
title: Users
---
<!-- DO NOT EDIT | GENERATED CONTENT -->
## Get users
+6 -1
View File
@@ -1,4 +1,9 @@
# WorkspaceProxies
---
# Code generated by make gen. DO NOT EDIT.
title: WorkspaceProxies
---
<!-- DO NOT EDIT | GENERATED CONTENT -->
## Get site-wide regions for workspace connections
+6 -1
View File
@@ -1,4 +1,9 @@
# Workspaces
---
# Code generated by make gen. DO NOT EDIT.
title: Workspaces
---
<!-- DO NOT EDIT | GENERATED CONTENT -->
## Create user workspace by organization
+6 -1
View File
@@ -1,5 +1,10 @@
---
# Code generated by make gen. DO NOT EDIT.
title: agent-firewall
description: Network isolation tool for monitoring and restricting HTTP/HTTPS requests
---
<!-- DO NOT EDIT | GENERATED CONTENT -->
# agent-firewall
Network isolation tool for monitoring and restricting HTTP/HTTPS requests
+6 -1
View File
@@ -1,5 +1,10 @@
---
# Code generated by make gen. DO NOT EDIT.
title: ai-gateway
description: Manage AI Gateway
---
<!-- DO NOT EDIT | GENERATED CONTENT -->
# ai-gateway
Manage AI Gateway
+6 -1
View File
@@ -1,5 +1,10 @@
---
# Code generated by make gen. DO NOT EDIT.
title: ai-gateway keys
description: Manage AI Gateway keys
---
<!-- DO NOT EDIT | GENERATED CONTENT -->
# ai-gateway keys
Manage AI Gateway keys
+6 -1
View File
@@ -1,5 +1,10 @@
---
# Code generated by make gen. DO NOT EDIT.
title: ai-gateway keys create
description: Create an AI Gateway key
---
<!-- DO NOT EDIT | GENERATED CONTENT -->
# ai-gateway keys create
Create an AI Gateway key
+6 -1
View File
@@ -1,5 +1,10 @@
---
# Code generated by make gen. DO NOT EDIT.
title: ai-gateway keys delete
description: Delete an AI Gateway key
---
<!-- DO NOT EDIT | GENERATED CONTENT -->
# ai-gateway keys delete
Delete an AI Gateway key
+6 -1
View File
@@ -1,5 +1,10 @@
---
# Code generated by make gen. DO NOT EDIT.
title: ai-gateway keys list
description: List AI Gateway keys
---
<!-- DO NOT EDIT | GENERATED CONTENT -->
# ai-gateway keys list
List AI Gateway keys
+6 -1
View File
@@ -1,5 +1,10 @@
---
# Code generated by make gen. DO NOT EDIT.
title: ai-gateway start
description: Run a standalone AI Gateway server
---
<!-- DO NOT EDIT | GENERATED CONTENT -->
# ai-gateway start
Run a standalone AI Gateway server
+6 -1
View File
@@ -1,5 +1,10 @@
---
# Code generated by make gen. DO NOT EDIT.
title: autoupdate
description: Toggle auto-update policy for a workspace
---
<!-- DO NOT EDIT | GENERATED CONTENT -->
# autoupdate
Toggle auto-update policy for a workspace
+6 -1
View File
@@ -1,5 +1,10 @@
---
# Code generated by make gen. DO NOT EDIT.
title: completion
description: Install or update shell completion scripts for the detected or chosen shell.
---
<!-- DO NOT EDIT | GENERATED CONTENT -->
# completion
Install or update shell completion scripts for the detected or chosen shell.
+6 -1
View File
@@ -1,5 +1,10 @@
---
# Code generated by make gen. DO NOT EDIT.
title: config-ssh
description: "Add an SSH Host entry for your workspaces \"ssh workspace.coder\""
---
<!-- DO NOT EDIT | GENERATED CONTENT -->
# config-ssh
Add an SSH Host entry for your workspaces "ssh workspace.coder"
+6 -1
View File
@@ -1,5 +1,10 @@
---
# Code generated by make gen. DO NOT EDIT.
title: create
description: Create a workspace
---
<!-- DO NOT EDIT | GENERATED CONTENT -->
# create
Create a workspace
+6 -1
View File
@@ -1,5 +1,10 @@
---
# Code generated by make gen. DO NOT EDIT.
title: delete
description: Delete a workspace
---
<!-- DO NOT EDIT | GENERATED CONTENT -->
# delete
Delete a workspace
+6 -1
View File
@@ -1,5 +1,10 @@
---
# Code generated by make gen. DO NOT EDIT.
title: dotfiles
description: Personalize your workspace by applying a canonical dotfiles repository
---
<!-- DO NOT EDIT | GENERATED CONTENT -->
# dotfiles
Personalize your workspace by applying a canonical dotfiles repository
+6 -1
View File
@@ -1,5 +1,10 @@
---
# Code generated by make gen. DO NOT EDIT.
title: external-auth
description: Manage external authentication
---
<!-- DO NOT EDIT | GENERATED CONTENT -->
# external-auth
Manage external authentication
+6 -1
View File
@@ -1,5 +1,10 @@
---
# Code generated by make gen. DO NOT EDIT.
title: external-auth access-token
description: Print auth for an external provider
---
<!-- DO NOT EDIT | GENERATED CONTENT -->
# external-auth access-token
Print auth for an external provider
+6 -1
View File
@@ -1,5 +1,10 @@
---
# Code generated by make gen. DO NOT EDIT.
title: external-workspaces
description: Create or manage external workspaces
---
<!-- DO NOT EDIT | GENERATED CONTENT -->
# external-workspaces
Create or manage external workspaces
@@ -1,5 +1,10 @@
---
# Code generated by make gen. DO NOT EDIT.
title: external-workspaces agent-instructions
description: Get the instructions for an external agent
---
<!-- DO NOT EDIT | GENERATED CONTENT -->
# external-workspaces agent-instructions
Get the instructions for an external agent
+6 -1
View File
@@ -1,5 +1,10 @@
---
# Code generated by make gen. DO NOT EDIT.
title: external-workspaces create
description: Create a new external workspace
---
<!-- DO NOT EDIT | GENERATED CONTENT -->
# external-workspaces create
Create a new external workspace
+6 -1
View File
@@ -1,5 +1,10 @@
---
# Code generated by make gen. DO NOT EDIT.
title: external-workspaces list
description: List external workspaces
---
<!-- DO NOT EDIT | GENERATED CONTENT -->
# external-workspaces list
List external workspaces
+6 -1
View File
@@ -1,5 +1,10 @@
---
# Code generated by make gen. DO NOT EDIT.
title: favorite
description: Add a workspace to your favorites
---
<!-- DO NOT EDIT | GENERATED CONTENT -->
# favorite
Add a workspace to your favorites
+6 -1
View File
@@ -1,5 +1,10 @@
---
# Code generated by make gen. DO NOT EDIT.
title: features
description: List Enterprise features
---
<!-- DO NOT EDIT | GENERATED CONTENT -->
# features
List Enterprise features
+5 -1
View File
@@ -1,5 +1,9 @@
---
# Code generated by make gen. DO NOT EDIT.
title: features list
---
<!-- DO NOT EDIT | GENERATED CONTENT -->
# features list
Aliases:
+6 -1
View File
@@ -1,5 +1,10 @@
---
# Code generated by make gen. DO NOT EDIT.
title: groups
description: Manage groups
---
<!-- DO NOT EDIT | GENERATED CONTENT -->
# groups
Manage groups
+6 -1
View File
@@ -1,5 +1,10 @@
---
# Code generated by make gen. DO NOT EDIT.
title: groups create
description: Create a user group
---
<!-- DO NOT EDIT | GENERATED CONTENT -->
# groups create
Create a user group
+6 -1
View File
@@ -1,5 +1,10 @@
---
# Code generated by make gen. DO NOT EDIT.
title: groups delete
description: Delete a user group
---
<!-- DO NOT EDIT | GENERATED CONTENT -->
# groups delete
Delete a user group
+6 -1
View File
@@ -1,5 +1,10 @@
---
# Code generated by make gen. DO NOT EDIT.
title: groups edit
description: Edit a user group
---
<!-- DO NOT EDIT | GENERATED CONTENT -->
# groups edit
Edit a user group
+6 -1
View File
@@ -1,5 +1,10 @@
---
# Code generated by make gen. DO NOT EDIT.
title: groups list
description: List user groups
---
<!-- DO NOT EDIT | GENERATED CONTENT -->
# groups list
List user groups
+7 -1
View File
@@ -1,5 +1,11 @@
---
# Code generated by make gen. DO NOT EDIT.
title: Command Line
description: "Reference for the Coder command-line interface, with usage and flags for every command."
icon_path: "./images/icons/terminal.svg"
---
<!-- DO NOT EDIT | GENERATED CONTENT -->
# coder
## Usage
+6 -1
View File
@@ -1,5 +1,10 @@
---
# Code generated by make gen. DO NOT EDIT.
title: licenses
description: "Add, delete, and list licenses"
---
<!-- DO NOT EDIT | GENERATED CONTENT -->
# licenses
Add, delete, and list licenses
+6 -1
View File
@@ -1,5 +1,10 @@
---
# Code generated by make gen. DO NOT EDIT.
title: licenses add
description: Add license to Coder deployment
---
<!-- DO NOT EDIT | GENERATED CONTENT -->
# licenses add
Add license to Coder deployment
+6 -1
View File
@@ -1,5 +1,10 @@
---
# Code generated by make gen. DO NOT EDIT.
title: licenses delete
description: Delete license by ID
---
<!-- DO NOT EDIT | GENERATED CONTENT -->
# licenses delete
Delete license by ID
+6 -1
View File
@@ -1,5 +1,10 @@
---
# Code generated by make gen. DO NOT EDIT.
title: licenses list
description: "List licenses (including expired)"
---
<!-- DO NOT EDIT | GENERATED CONTENT -->
# licenses list
List licenses (including expired)
+6 -1
View File
@@ -1,5 +1,10 @@
---
# Code generated by make gen. DO NOT EDIT.
title: list
description: List workspaces
---
<!-- DO NOT EDIT | GENERATED CONTENT -->
# list
List workspaces
+6 -1
View File
@@ -1,5 +1,10 @@
---
# Code generated by make gen. DO NOT EDIT.
title: login
description: Authenticate with Coder deployment
---
<!-- DO NOT EDIT | GENERATED CONTENT -->
# login
Authenticate with Coder deployment
+6 -1
View File
@@ -1,5 +1,10 @@
---
# Code generated by make gen. DO NOT EDIT.
title: login token
description: Print the current session token
---
<!-- DO NOT EDIT | GENERATED CONTENT -->
# login token
Print the current session token
+6 -1
View File
@@ -1,5 +1,10 @@
---
# Code generated by make gen. DO NOT EDIT.
title: logout
description: Unauthenticate your local session
---
<!-- DO NOT EDIT | GENERATED CONTENT -->
# logout
Unauthenticate your local session
+6 -1
View File
@@ -1,5 +1,10 @@
---
# Code generated by make gen. DO NOT EDIT.
title: logs
description: View logs for a workspace
---
<!-- DO NOT EDIT | GENERATED CONTENT -->
# logs
View logs for a workspace
+6 -1
View File
@@ -1,5 +1,10 @@
---
# Code generated by make gen. DO NOT EDIT.
title: netcheck
description: Print network debug information for DERP and STUN
---
<!-- DO NOT EDIT | GENERATED CONTENT -->
# netcheck
Print network debug information for DERP and STUN
+6 -1
View File
@@ -1,5 +1,10 @@
---
# Code generated by make gen. DO NOT EDIT.
title: notifications
description: Manage Coder notifications
---
<!-- DO NOT EDIT | GENERATED CONTENT -->
# notifications
Manage Coder notifications
+6 -1
View File
@@ -1,5 +1,10 @@
---
# Code generated by make gen. DO NOT EDIT.
title: notifications custom
description: Send a custom notification
---
<!-- DO NOT EDIT | GENERATED CONTENT -->
# notifications custom
Send a custom notification
+6 -1
View File
@@ -1,5 +1,10 @@
---
# Code generated by make gen. DO NOT EDIT.
title: notifications pause
description: Pause notifications
---
<!-- DO NOT EDIT | GENERATED CONTENT -->
# notifications pause
Pause notifications
+6 -1
View File
@@ -1,5 +1,10 @@
---
# Code generated by make gen. DO NOT EDIT.
title: notifications resume
description: Resume notifications
---
<!-- DO NOT EDIT | GENERATED CONTENT -->
# notifications resume
Resume notifications
+6 -1
View File
@@ -1,5 +1,10 @@
---
# Code generated by make gen. DO NOT EDIT.
title: notifications test
description: Send a test notification
---
<!-- DO NOT EDIT | GENERATED CONTENT -->
# notifications test
Send a test notification
+6 -1
View File
@@ -1,5 +1,10 @@
---
# Code generated by make gen. DO NOT EDIT.
title: oauth2-provider
description: Manage Coder OAuth2 provider settings
---
<!-- DO NOT EDIT | GENERATED CONTENT -->
# oauth2-provider
Manage Coder OAuth2 provider settings
+6 -1
View File
@@ -1,5 +1,10 @@
---
# Code generated by make gen. DO NOT EDIT.
title: oauth2-provider dcr
description: "Manage OAuth2 dynamic client registration (RFC 7591)"
---
<!-- DO NOT EDIT | GENERATED CONTENT -->
# oauth2-provider dcr
Manage OAuth2 dynamic client registration (RFC 7591)
+6 -1
View File
@@ -1,5 +1,10 @@
---
# Code generated by make gen. DO NOT EDIT.
title: oauth2-provider dcr disable
description: Disable OAuth2 dynamic client registration
---
<!-- DO NOT EDIT | GENERATED CONTENT -->
# oauth2-provider dcr disable
Disable OAuth2 dynamic client registration
+6 -1
View File
@@ -1,5 +1,10 @@
---
# Code generated by make gen. DO NOT EDIT.
title: oauth2-provider dcr enable
description: Enable OAuth2 dynamic client registration
---
<!-- DO NOT EDIT | GENERATED CONTENT -->
# oauth2-provider dcr enable
Enable OAuth2 dynamic client registration
+6 -1
View File
@@ -1,5 +1,10 @@
---
# Code generated by make gen. DO NOT EDIT.
title: open
description: Open a workspace
---
<!-- DO NOT EDIT | GENERATED CONTENT -->
# open
Open a workspace
+6 -1
View File
@@ -1,5 +1,10 @@
---
# Code generated by make gen. DO NOT EDIT.
title: open app
description: Open a workspace application.
---
<!-- DO NOT EDIT | GENERATED CONTENT -->
# open app
Open a workspace application.
+6 -1
View File
@@ -1,5 +1,10 @@
---
# Code generated by make gen. DO NOT EDIT.
title: open vscode
description: Open a workspace in VS Code Desktop
---
<!-- DO NOT EDIT | GENERATED CONTENT -->
# open vscode
Open a workspace in VS Code Desktop
+6 -1
View File
@@ -1,5 +1,10 @@
---
# Code generated by make gen. DO NOT EDIT.
title: organizations
description: Organization related commands
---
<!-- DO NOT EDIT | GENERATED CONTENT -->
# organizations
Organization related commands
+6 -1
View File
@@ -1,5 +1,10 @@
---
# Code generated by make gen. DO NOT EDIT.
title: organizations create
description: Create a new organization.
---
<!-- DO NOT EDIT | GENERATED CONTENT -->
# organizations create
Create a new organization.
+6 -1
View File
@@ -1,5 +1,10 @@
---
# Code generated by make gen. DO NOT EDIT.
title: organizations delete
description: Delete an organization
---
<!-- DO NOT EDIT | GENERATED CONTENT -->
# organizations delete
Delete an organization
+6 -1
View File
@@ -1,5 +1,10 @@
---
# Code generated by make gen. DO NOT EDIT.
title: organizations list
description: List all organizations
---
<!-- DO NOT EDIT | GENERATED CONTENT -->
# organizations list
List all organizations
+6 -1
View File
@@ -1,5 +1,10 @@
---
# Code generated by make gen. DO NOT EDIT.
title: organizations members
description: Manage organization members
---
<!-- DO NOT EDIT | GENERATED CONTENT -->
# organizations members
Manage organization members
+6 -1
View File
@@ -1,5 +1,10 @@
---
# Code generated by make gen. DO NOT EDIT.
title: organizations members add
description: Add a new member to the current organization
---
<!-- DO NOT EDIT | GENERATED CONTENT -->
# organizations members add
Add a new member to the current organization
+6 -1
View File
@@ -1,5 +1,10 @@
---
# Code generated by make gen. DO NOT EDIT.
title: organizations members edit-roles
description: "Edit organization member's roles"
---
<!-- DO NOT EDIT | GENERATED CONTENT -->
# organizations members edit-roles
Edit organization member's roles
+6 -1
View File
@@ -1,5 +1,10 @@
---
# Code generated by make gen. DO NOT EDIT.
title: organizations members list
description: List all organization members
---
<!-- DO NOT EDIT | GENERATED CONTENT -->
# organizations members list
List all organization members
+6 -1
View File
@@ -1,5 +1,10 @@
---
# Code generated by make gen. DO NOT EDIT.
title: organizations members remove
description: Remove a new member to the current organization
---
<!-- DO NOT EDIT | GENERATED CONTENT -->
# organizations members remove
Remove a new member to the current organization
+6 -1
View File
@@ -1,5 +1,10 @@
---
# Code generated by make gen. DO NOT EDIT.
title: organizations roles
description: Manage organization roles.
---
<!-- DO NOT EDIT | GENERATED CONTENT -->
# organizations roles
Manage organization roles.
+6 -1
View File
@@ -1,5 +1,10 @@
---
# Code generated by make gen. DO NOT EDIT.
title: organizations roles create
description: Create a new organization custom role
---
<!-- DO NOT EDIT | GENERATED CONTENT -->
# organizations roles create
Create a new organization custom role
+6 -1
View File
@@ -1,5 +1,10 @@
---
# Code generated by make gen. DO NOT EDIT.
title: organizations roles show
description: "Show role(s)"
---
<!-- DO NOT EDIT | GENERATED CONTENT -->
# organizations roles show
Show role(s)
+6 -1
View File
@@ -1,5 +1,10 @@
---
# Code generated by make gen. DO NOT EDIT.
title: organizations roles update
description: Update an organization custom role
---
<!-- DO NOT EDIT | GENERATED CONTENT -->
# organizations roles update
Update an organization custom role
+6 -1
View File
@@ -1,5 +1,10 @@
---
# Code generated by make gen. DO NOT EDIT.
title: organizations settings
description: Manage organization settings.
---
<!-- DO NOT EDIT | GENERATED CONTENT -->
# organizations settings
Manage organization settings.
+6 -1
View File
@@ -1,5 +1,10 @@
---
# Code generated by make gen. DO NOT EDIT.
title: organizations settings set
description: Update specified organization setting.
---
<!-- DO NOT EDIT | GENERATED CONTENT -->
# organizations settings set
Update specified organization setting.
+6 -1
View File
@@ -1,5 +1,10 @@
---
# Code generated by make gen. DO NOT EDIT.
title: organizations settings set group-sync
description: Group sync settings to sync groups from an IdP.
---
<!-- DO NOT EDIT | GENERATED CONTENT -->
# organizations settings set group-sync
Group sync settings to sync groups from an IdP.
@@ -1,5 +1,10 @@
---
# Code generated by make gen. DO NOT EDIT.
title: organizations settings set organization-sync
description: Organization sync settings to sync organization memberships from an IdP.
---
<!-- DO NOT EDIT | GENERATED CONTENT -->
# organizations settings set organization-sync
Organization sync settings to sync organization memberships from an IdP.
+6 -1
View File
@@ -1,5 +1,10 @@
---
# Code generated by make gen. DO NOT EDIT.
title: organizations settings set role-sync
description: Role sync settings to sync organization roles from an IdP.
---
<!-- DO NOT EDIT | GENERATED CONTENT -->
# organizations settings set role-sync
Role sync settings to sync organization roles from an IdP.

Some files were not shown because too many files have changed in this diff Show More