Thanks to visit codestin.com
Credit goes to github.com

Skip to content

docs: correct broken CLI commands and flags from drift sweep (#28098) - #28165

Merged
nickvigilante merged 1 commit into
release/2.36from
backport/28098-to-2.36
Aug 14, 2026
Merged

docs: correct broken CLI commands and flags from drift sweep (#28098)#28165
nickvigilante merged 1 commit into
release/2.36from
backport/28098-to-2.36

Conversation

@github-actions

Copy link
Copy Markdown
Contributor

Backport of #28098

Original PR: #28098 — docs: correct broken CLI commands and flags from drift sweep
Merge commit: 58de9ab
Requested by: @nickvigilante

## Summary

Corrects broken CLI commands and flags surfaced by the DOCS-637
full-corpus runtime drift sweep. Each fix was verified against the
generated CLI reference (`docs/reference/cli/*`) and, where relevant,
`codersdk` source.

## Changes

| Page | Fix |
|------|-----|
| `docs/user-guides/workspace-access/index.md` | `coder port forward` →
`coder port-forward` (the space form is unrecognized; the command is
hyphenated). |
| `docs/ai-coder/github-to-tasks.md` | Remove `coder templates list
--org your-org-name` in two spots — `templates list` has no `--org` flag
(`unknown flag: --org`). |
| `docs/admin/infrastructure/scale-utility.md` | `--cleanup-timeout
15min` → `15m` — Go durations reject the `min` unit (`invalid duration:
unknown unit "min"`). |
| `docs/admin/integrations/dx-data-cloud.md` | `coder users list >
users.csv` emitted a whitespace table, not CSV. Emit JSON and convert to
real CSV with `jq`, mirroring the API tab on the same page and using the
same columns as the default table view
(`username,email,created_at,status`). |

## Notes / judgment calls

- **dx-data-cloud (CSV):** the page genuinely needs CSV (the DX CSM
imports a CSV, and the API tab already produces one via `jq ... @csv`).
`coder users list` only supports `--output table|json`, so the CLI tab
now produces real CSV via `jq` rather than switching the page to JSON.
- **scale-utility `:109` left as-is:** `--target-users 0:100` is
prefixed with "For dashboard traffic:", which correctly scopes it to the
`scaletest dashboard` subcommand, so it is not drift.
- **Excluded — sessions-tokens `--lifetime=720h`:** the sweep flagged
this because the throwaway SUT capped token lifetime at 168h, but
`--max-token-lifetime` defaults to `876600h` (~100 years), so the
example is valid on a default deployment. The `CODER_MAX_TOKEN_LIFETIME`
dependency is also already documented in the page's "Set max token
length" section. No change needed.

Linear: https://linear.app/codercom/issue/DOCS-641

> This PR was created with AI assistance (Coder Agents).

(cherry picked from commit 58de9ab)
@github-actions
github-actions Bot requested a review from a team as a code owner August 14, 2026 16:51
@github-actions github-actions Bot added the backport/v2.36 Backport PR targeting release/2.36 label Aug 14, 2026
@github-actions
github-actions Bot requested a review from nickvigilante August 14, 2026 16:51
@nickvigilante
nickvigilante enabled auto-merge (squash) August 14, 2026 16:52
@nickvigilante
nickvigilante merged commit 81f0dce into release/2.36 Aug 14, 2026
@nickvigilante
nickvigilante deleted the backport/28098-to-2.36 branch August 14, 2026 16:52
@github-actions github-actions Bot locked and limited conversation to collaborators Aug 14, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

backport/v2.36 Backport PR targeting release/2.36

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant