diff --git a/cli/create.go b/cli/create.go index 9b5e1a0c4cd09..f3709314cd2be 100644 --- a/cli/create.go +++ b/cli/create.go @@ -39,7 +39,7 @@ func (r *RootCmd) create() *serpent.Command { client := new(codersdk.Client) cmd := &serpent.Command{ Annotations: workspaceCommand, - Use: "create [name]", + Use: "create [workspace]", Short: "Create a workspace", Long: FormatExamples( Example{ diff --git a/cli/delete.go b/cli/delete.go index 04303a706fb8a..a0988bb4cdeff 100644 --- a/cli/delete.go +++ b/cli/delete.go @@ -21,6 +21,12 @@ func (r *RootCmd) deleteWorkspace() *serpent.Command { Annotations: workspaceCommand, Use: "delete ", Short: "Delete a workspace", + Long: FormatExamples( + Example{ + Description: "Delete a workspace for another user (if you have permission)", + Command: "coder delete /", + }, + ), Middleware: serpent.Chain( serpent.RequireNArgs(1), r.InitClient(client), diff --git a/cli/testdata/coder_create_--help.golden b/cli/testdata/coder_create_--help.golden index ab426bcb37f9b..8e8ea4a1701eb 100644 --- a/cli/testdata/coder_create_--help.golden +++ b/cli/testdata/coder_create_--help.golden @@ -1,7 +1,7 @@ coder v0.0.0-devel USAGE: - coder create [flags] [name] + coder create [flags] [workspace] Create a workspace diff --git a/cli/testdata/coder_delete_--help.golden b/cli/testdata/coder_delete_--help.golden index 3f9800f135840..f9dfc9b9b93df 100644 --- a/cli/testdata/coder_delete_--help.golden +++ b/cli/testdata/coder_delete_--help.golden @@ -7,6 +7,10 @@ USAGE: Aliases: rm + - Delete a workspace for another user (if you have permission): + + $ coder delete / + OPTIONS: --orphan bool Delete a workspace without deleting its resources. This can delete a diff --git a/docs/reference/cli/create.md b/docs/reference/cli/create.md index c165b33f4ef91..377dda14189e4 100644 --- a/docs/reference/cli/create.md +++ b/docs/reference/cli/create.md @@ -7,7 +7,7 @@ Create a workspace ## Usage ```console -coder create [flags] [name] +coder create [flags] [workspace] ``` ## Description diff --git a/docs/reference/cli/delete.md b/docs/reference/cli/delete.md index 7ea5eb0839042..b5093efa63f0a 100644 --- a/docs/reference/cli/delete.md +++ b/docs/reference/cli/delete.md @@ -14,6 +14,14 @@ Aliases: coder delete [flags] ``` +## Description + +```console + - Delete a workspace for another user (if you have permission): + + $ coder delete / +``` + ## Options ### --orphan