Files
coder/docs/reference/cli/config-ssh.md
T
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

4.8 KiB
Generated

title, description
title description
`coder config-ssh` Add an SSH Host entry for your workspaces "ssh workspace.coder".

Add an SSH Host entry for your workspaces "ssh workspace.coder"

Usage

coder config-ssh [flags]

Description

  - You can use -o (or --ssh-option) so set SSH options to be used for all your
workspaces:

     $ coder config-ssh -o ForwardAgent=yes

  - You can use --dry-run (or -n) to see the changes that would be made:

     $ coder config-ssh --dry-run

Options

--ssh-config-file

Type string
Environment $CODER_SSH_CONFIG_FILE
Default ~/.ssh/config

Specifies the path to an SSH config.

--coder-binary-path

Type string
Environment $CODER_SSH_CONFIG_BINARY_PATH

Optionally specify the absolute path to the coder binary used in ProxyCommand. By default, the binary invoking this command ('config ssh') is used.

-o, --ssh-option

Type string-array
Environment $CODER_SSH_CONFIG_OPTS

Specifies additional SSH options to embed in each host stanza.

-n, --dry-run

Type bool
Environment $CODER_SSH_DRY_RUN

Perform a trial run with no changes made, showing a diff at the end.

--use-previous-options

Type bool
Environment $CODER_SSH_USE_PREVIOUS_OPTIONS

Specifies whether or not to keep options from previous run of config-ssh.

--ssh-host-prefix

Type string
Environment $CODER_CONFIGSSH_SSH_HOST_PREFIX

Override the default host prefix.

--hostname-suffix

Type string
Environment $CODER_CONFIGSSH_HOSTNAME_SUFFIX

Override the default hostname suffix.

--wait

Type yes|no|auto
Environment $CODER_CONFIGSSH_WAIT
Default auto

Specifies whether or not to wait for the startup script to finish executing. Auto means that the agent startup script behavior configured in the workspace template is used.

--disable-autostart

Type bool
Environment $CODER_CONFIGSSH_DISABLE_AUTOSTART
Default false

Disable starting the workspace automatically when connecting via SSH.

--no-wildcard

Type bool
Environment $CODER_CONFIGSSH_NO_WILDCARD
Default false

Generate an individual host entry for each workspace instead of a wildcard host block. This allows third-party tools and SSH clients to discover workspaces by reading the config file.

--force-unix-filepaths

Type bool
Environment $CODER_CONFIGSSH_UNIX_FILEPATHS

By default, 'config-ssh' uses the os path separator when writing the ssh config. This might be an issue in Windows machine that use a unix-like shell. This flag forces the use of unix file paths (the forward slash '/').

-y, --yes

Type bool

Bypass confirmation prompts.