update cli usage doc

johnstcn · johnstcn · commit 9389dd19c4ab · 2025-06-18T14:59:13.000+01:00
diff --git a/cli/testdata/coder_--help.golden b/cli/testdata/coder_--help.golden
@@ -57,7 +57,8 @@ SUBCOMMANDS:
     tokens            Manage personal access tokens
     unfavorite        Remove a workspace from your favorites
     update            Will update and start a given workspace if it is out of
-                      date
+                      date. If the workspace is already running, it will be
+                      stopped first.
     users             Manage users
     version           Show coder version
     whoami            Fetch authenticated user info for Coder deployment
diff --git a/cli/testdata/coder_update_--help.golden b/cli/testdata/coder_update_--help.golden
@@ -3,7 +3,8 @@ coder v0.0.0-devel
 USAGE:
   coder update [flags] <workspace>
 
-  Will update and start a given workspace if it is out of date
+  Will update and start a given workspace if it is out of date. If the workspace
+  is already running, it will be stopped first.
 
   Use --always-prompt to change the parameter values of the workspace.
 
diff --git a/cli/update.go b/cli/update.go
@@ -19,7 +19,7 @@ func (r *RootCmd) update() *serpent.Command {
 	cmd := &serpent.Command{
 		Annotations: workspaceCommand,
 		Use:         "update <workspace>",
-		Short:       "Will update and start a given workspace if it is out of date",
+		Short:       "Will update and start a given workspace if it is out of date. If the workspace is already running, it will be stopped first.",
 		Long:        "Use --always-prompt to change the parameter values of the workspace.",
 		Middleware: serpent.Chain(
 			serpent.RequireNArgs(1),
diff --git a/docs/manifest.json b/docs/manifest.json
@@ -1694,7 +1694,7 @@
 						},
 						{
 							"title": "update",
-							"description": "Will update and start a given workspace if it is out of date",
+							"description": "Will update and start a given workspace if it is out of date. If the workspace is already running, it will be stopped first.",
 							"path": "reference/cli/update.md"
 						},
 						{
diff --git a/docs/reference/cli/index.md b/docs/reference/cli/index.md
diff --git a/docs/reference/cli/update.md b/docs/reference/cli/update.md

Original file line number	Diff line number	Diff line change
`@@ -1694,7 +1694,7 @@`
`1694`	`1694`	`},`
`1695`	`1695`	`{`
`1696`	`1696`	`"title": "update",`
`1697`		`- "description": "Will update and start a given workspace if it is out of date",`
	`1697`	`+ "description": "Will update and start a given workspace if it is out of date. If the workspace is already running, it will be stopped first.",`
`1698`	`1698`	`"path": "reference/cli/update.md"`
`1699`	`1699`	`},`
`1700`	`1700`	`{`