docs: correct broken CLI commands and flags from drift sweep - #28098
Draft
nickvigilante wants to merge 1 commit into
Draft
docs: correct broken CLI commands and flags from drift sweep#28098nickvigilante wants to merge 1 commit into
nickvigilante wants to merge 1 commit into
Conversation
Fixes CLI command/flag drift found in the DOCS-637 runtime sweep, each verified against the generated CLI reference and codersdk source: - workspace-access: `coder port forward` -> `coder port-forward` (the space form is unrecognized). - github-to-tasks: remove `coder templates list --org your-org-name` (two spots); `templates list` has no `--org` flag. - scale-utility: `--cleanup-timeout 15min` -> `15m` (Go durations reject the "min" unit). - dx-data-cloud: `coder users list > users.csv` emitted a table, not CSV. Emit JSON and convert to real CSV with jq, matching the API tab. Excludes the sessions-tokens `--lifetime=720h` finding: it is valid on a default deployment (max-token-lifetime defaults to ~100y) and the CODER_MAX_TOKEN_LIFETIME dependency is already documented on the page. > This PR was created with AI assistance (Coder Agents).
Docs previewCheck off each page once it's been reviewed. If a page changes in a later push, its checkbox clears automatically so it gets a fresh look. Pages not yet wired into the docs navigation aren't listed here. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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,codersdksource.Changes
docs/user-guides/workspace-access/index.mdcoder port forward→coder port-forward(the space form is unrecognized; the command is hyphenated).docs/ai-coder/github-to-tasks.mdcoder templates list --org your-org-namein two spots —templates listhas no--orgflag (unknown flag: --org).docs/admin/infrastructure/scale-utility.md--cleanup-timeout 15min→15m— Go durations reject theminunit (invalid duration: unknown unit "min").docs/admin/integrations/dx-data-cloud.mdcoder users list > users.csvemitted a whitespace table, not CSV. Emit JSON and convert to real CSV withjq, 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
jq ... @csv).coder users listonly supports--output table|json, so the CLI tab now produces real CSV viajqrather than switching the page to JSON.:109left as-is:--target-users 0:100is prefixed with "For dashboard traffic:", which correctly scopes it to thescaletest dashboardsubcommand, so it is not drift.--lifetime=720h: the sweep flagged this because the throwaway SUT capped token lifetime at 168h, but--max-token-lifetimedefaults to876600h(~100 years), so the example is valid on a default deployment. TheCODER_MAX_TOKEN_LIFETIMEdependency is also already documented in the page's "Set max token length" section. No change needed.Linear: https://linear.app/codercom/issue/DOCS-641