Skip to content

fix(docs): correct broken CLI commands and flags from drift sweep (backport to release/2.29) #28176

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
nickvigilante wants to merge 1 commit into
base: release/2.29
Choose a base branch
from
+8 −6
Open

fix(docs): correct broken CLI commands and flags from drift sweep (backport to release/2.29) #28176

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/admin/infrastructure/scale-utility.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,7 @@ wish to clean up all workspaces, you can run the following command:
```shell
coder exp scaletest cleanup \
--cleanup-job-timeout 2h \
--cleanup-timeout 15min
--cleanup-timeout 15m
```

This will delete all workspaces and users with the prefix `scaletest-`.
Expand Down
5 changes: 3 additions & 2 deletions docs/admin/integrations/dx-data-cloud.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,10 +30,11 @@ If your organization already uses the Coder-DX integration, you can find a list

### CLI

Use `users list` to export the list of users to a CSV file:
Use `users list` with `jq` to export the list of users to a CSV file:

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

Visit the [users list](../../reference/cli/users_list.md) documentation for more options.
Expand Down
5 changes: 3 additions & 2 deletions docs/admin/users/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -215,10 +215,11 @@ You can use the Coder CLI or API to retrieve your list of users.

### CLI

Use `users list` to export the list of users to a CSV file:
Use `users list` with `jq` to export the list of users to a CSV file:

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

Visit the [users list](../../reference/cli/users_list.md) documentation for more options.
Expand Down
2 changes: 1 addition & 1 deletion docs/user-guides/workspace-access/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,7 @@ services or preview environments.

You can also [share ports](./port-forwarding.md#sharing-ports) with other users,
or [port-forward](./port-forwarding.md#the-coder-port-forward-command) through
the CLI with `coder port forward`. Read more in the
the CLI with `coder port-forward`. Read more in the
[docs on workspace ports](./port-forwarding.md).

![Open Ports window](../../images/networking/listeningports.png)
Expand Down
Loading