From 9b1d8f79ae07092bba4a50769790436faea7a3a6 Mon Sep 17 00:00:00 2001 From: Jaayden Halko Date: Mon, 1 Jul 2024 12:44:32 -0400 Subject: [PATCH] docs: update workspace filters docs (#13725) --- docs/workspaces.md | 21 +++++++++++++++------ 1 file changed, 15 insertions(+), 6 deletions(-) diff --git a/docs/workspaces.md b/docs/workspaces.md index 52a1317a82..5c3abe3646 100644 --- a/docs/workspaces.md +++ b/docs/workspaces.md @@ -35,17 +35,26 @@ coder show ## Workspace filtering In the Coder UI, you can filter your workspaces using pre-defined filters or -Coder's filter query. For example, you can find the workspaces that you own or -that are currently running. +Coder's filter query. Filters follow the pattern `[filter name]:[filter text]` +and multiple filters can be specified separated by a space i.e +`owner:me status:running` The following filters are supported: - `owner` - Represents the `username` of the owner. You can also use `me` as a - convenient alias for the logged-in user. -- `template` - Specifies the name of the template. -- `status` - Indicates the status of the workspace. For a list of supported - statuses, see + convenient alias for the logged-in user, e.g., `owner:me` +- `name` - Name of the workspace. +- `template` - Name of the template. +- `status` - Indicates the status of the workspace, e.g, `status:failed` For a + list of supported statuses, see [WorkspaceStatus documentation](https://pkg.go.dev/github.com/coder/coder/codersdk#WorkspaceStatus). +- `outdated` - Filters workspaces using an outdated template version, e.g, + `outdated:true` +- `dormant` - Filters workspaces based on the dormant state, e.g `dormant:true` +- `has-agent` - Only applicable for workspaces in "start" transition. Stopped + and deleted workspaces don't have agents. List of supported values + `connecting|connected|timeout`, e.g, `has-agent:connecting` +- `id` - Workspace UUID ## Starting and stopping workspaces