Skip to content

Commit 9b1d8f7

Browse files
authored
docs: update workspace filters docs (coder#13725)
1 parent d8d86b1 commit 9b1d8f7

File tree

1 file changed

+15
-6
lines changed

1 file changed

+15
-6
lines changed

docs/workspaces.md

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -35,17 +35,26 @@ coder show <workspace-name>
3535
## Workspace filtering
3636

3737
In the Coder UI, you can filter your workspaces using pre-defined filters or
38-
Coder's filter query. For example, you can find the workspaces that you own or
39-
that are currently running.
38+
Coder's filter query. Filters follow the pattern `[filter name]:[filter text]`
39+
and multiple filters can be specified separated by a space i.e
40+
`owner:me status:running`
4041

4142
The following filters are supported:
4243

4344
- `owner` - Represents the `username` of the owner. You can also use `me` as a
44-
convenient alias for the logged-in user.
45-
- `template` - Specifies the name of the template.
46-
- `status` - Indicates the status of the workspace. For a list of supported
47-
statuses, see
45+
convenient alias for the logged-in user, e.g., `owner:me`
46+
- `name` - Name of the workspace.
47+
- `template` - Name of the template.
48+
- `status` - Indicates the status of the workspace, e.g, `status:failed` For a
49+
list of supported statuses, see
4850
[WorkspaceStatus documentation](https://pkg.go.dev/github.com/coder/coder/codersdk#WorkspaceStatus).
51+
- `outdated` - Filters workspaces using an outdated template version, e.g,
52+
`outdated:true`
53+
- `dormant` - Filters workspaces based on the dormant state, e.g `dormant:true`
54+
- `has-agent` - Only applicable for workspaces in "start" transition. Stopped
55+
and deleted workspaces don't have agents. List of supported values
56+
`connecting|connected|timeout`, e.g, `has-agent:connecting`
57+
- `id` - Workspace UUID
4958

5059
## Starting and stopping workspaces
5160

0 commit comments

Comments
 (0)