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

Skip to content

Commit f930866

Browse files
nickvigilantenickvigilante
authored
fix(docs): correct broken CLI commands and flags from drift sweep (backport to release/2.34) (#28173)
Backport of #28098 to `release/2.34` (ESR). Cherry-picked `58de9ab8f87e` from `main` via `git cherry-pick -x`. Three of the five files applied cleanly. **Conflicts resolved manually:** `docs/admin/integrations/dx-data-cloud.md` and `docs/admin/users/index.md`. On `release/2.34` both blocks use a ` ```shell ` fence where `main` uses ` ```sh `; that fence difference is an unrelated cross-branch divergence. This backport keeps 2.34's existing `shell` fence (which also matches the neighboring code blocks in those files) and applies #28098's intended change: replacing the broken `coder users list > users.csv` with the `coder users list --output json | jq ... | @csv > users.csv` pipeline. The resulting commit touches the same five files with the same insertion/deletion counts as the original squash. The `backport` label on the original merged PR did not produce a 2.34 backport, so this is created by hand. 2.34 is listed in `scripts/release_channels/esr_versions.txt`, so it is a valid backport target. - Original PR: #28098 - Tracking: DOCS-651 > This PR was created with AI assistance (Coder Agents).
1 parent 54c8074 commit f930866

5 files changed

Lines changed: 9 additions & 10 deletions

File tree

‎docs/admin/infrastructure/scale-utility.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -130,7 +130,7 @@ wish to clean up all workspaces, you can run the following command:
130130
```shell
131131
coder exp scaletest cleanup \
132132
--cleanup-job-timeout 2h \
133-
--cleanup-timeout 15min
133+
--cleanup-timeout 15m
134134
```
135135

136136
This will delete all workspaces and users with the prefix `scaletest-`.

‎docs/admin/integrations/dx-data-cloud.md‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,10 +30,11 @@ If your organization already uses the Coder-DX integration, you can find a list
3030

3131
### CLI
3232

33-
Use `users list` to export the list of users to a CSV file:
33+
Use `users list` with `jq` to export the list of users to a CSV file:
3434

3535
```shell
36-
coder users list > users.csv
36+
coder users list --output json | \
37+
jq -r '["username","email","created_at","status"], (.[] | [.username, .email, .created_at, .status]) | @csv' > users.csv
3738
```
3839

3940
Visit the [users list](../../reference/cli/users_list.md) documentation for more options.

‎docs/admin/users/index.md‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -230,10 +230,11 @@ You can use the Coder CLI or API to retrieve your list of users.
230230

231231
### CLI
232232

233-
Use `users list` to export the list of users to a CSV file:
233+
Use `users list` with `jq` to export the list of users to a CSV file:
234234

235235
```shell
236-
coder users list > users.csv
236+
coder users list --output json | \
237+
jq -r '["username","email","created_at","status"], (.[] | [.username, .email, .created_at, .status]) | @csv' > users.csv
237238
```
238239

239240
Visit the [users list](../../reference/cli/users_list.md) documentation for more options.

‎docs/ai-coder/github-to-tasks.md‎

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -99,9 +99,6 @@ You must also set `coder-template-name` as part of this. The GHA example has thi
9999
```bash
100100
# List all templates in your organization
101101
coder templates list
102-
103-
# List templates in a specific organization
104-
coder templates list --org your-org-name
105102
```
106103

107104
You can also choose to modify the other [input parameters](https://github.com/coder/create-task-action?tab=readme-ov-file#inputs) to better fit your desired workflow.
@@ -229,7 +226,7 @@ Generate a new token with these permissions at `https://<your-coder-url>/deploym
229226

230227
**Solution:**
231228

232-
1. Verify the template name using: `coder templates list --org your-org-name`
229+
1. Verify the template name using: `coder templates list`
233230
1. Update the `coder-template-name` input in your workflow file to match exactly, or input secret or variable saved in GitHub
234231
1. Ensure the template exists in the organization specified by `coder-organization`
235232

‎docs/user-guides/workspace-access/index.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -176,7 +176,7 @@ services or preview environments.
176176
177177
You can also [share ports](./port-forwarding.md#sharing-ports) with other users,
178178
or [port-forward](./port-forwarding.md#the-coder-port-forward-command) through
179-
the CLI with `coder port forward`. Read more in the
179+
the CLI with `coder port-forward`. Read more in the
180180
[docs on workspace ports](./port-forwarding.md).
181181

182182
![Open Ports window](../../images/networking/listeningports.png)

0 commit comments

Comments
 (0)