Swap ws and workspaces

code-asher · code-asher · commit 7ef9bdf30e0a · 2021-05-14T12:18:01.000-05:00
diff --git a/ci/integration/integration_test.go b/ci/integration/integration_test.go
@@ -53,15 +53,15 @@ func TestCoderCLI(t *testing.T) {
 
 		headlessLogin(ctx, t, c)
 
-		c.Run(ctx, "coder ws").Assert(t,
+		c.Run(ctx, "coder workspaces").Assert(t,
 			tcli.Success(),
 		)
 
-		c.Run(ctx, "coder ws ls").Assert(t,
+		c.Run(ctx, "coder workspaces ls").Assert(t,
 			tcli.Success(),
 		)
 
-		c.Run(ctx, "coder ws ls -o json").Assert(t,
+		c.Run(ctx, "coder workspaces ls -o json").Assert(t,
 			tcli.Success(),
 		)
 
@@ -93,7 +93,7 @@ func TestCoderCLI(t *testing.T) {
 			tcli.Success(),
 		)
 
-		c.Run(ctx, "coder ws ls").Assert(t,
+		c.Run(ctx, "coder workspaces ls").Assert(t,
 			tcli.Error(),
 		)
 
diff --git a/ci/integration/ssh_test.go b/ci/integration/ssh_test.go
@@ -15,7 +15,7 @@ func TestSSH(t *testing.T) {
 
 		// TODO remove this once we can create a workspace if there aren't any
 		var workspaces []coder.Workspace
-		c.Run(ctx, "coder ws ls --output json").Assert(t,
+		c.Run(ctx, "coder workspaces ls --output json").Assert(t,
 			tcli.Success(),
 			tcli.StdoutJSONUnmarshal(&workspaces),
 		)
diff --git a/ci/integration/statictokens_test.go b/ci/integration/statictokens_test.go
@@ -35,15 +35,15 @@ func TestStaticAuth(t *testing.T) {
 
 		// make requests with token environment variable authentication
 		cmd := exec.CommandContext(ctx, "sh", "-c",
-			fmt.Sprintf("export CODER_URL=%s && export CODER_TOKEN=$(cat) && coder ws ls", os.Getenv("CODER_URL")),
+			fmt.Sprintf("export CODER_URL=%s && export CODER_TOKEN=$(cat) && coder workspaces ls", os.Getenv("CODER_URL")),
 		)
 		cmd.Stdin = strings.NewReader(string(result.Stdout))
 		c.RunCmd(cmd).Assert(t,
 			tcli.Success(),
 		)
 
 		// should error when the environment variables aren't set
-		c.Run(ctx, "coder ws ls").Assert(t,
+		c.Run(ctx, "coder workspaces ls").Assert(t,
 			tcli.Error(),
 		)
 	})
diff --git a/docs/coder.md b/docs/coder.md
@@ -21,5 +21,4 @@ coder provides a CLI for working with an existing Coder installation
 * [coder tokens](coder_tokens.md)	 - manage Coder API tokens for the active user
 * [coder urls](coder_urls.md)	 - Interact with workspace DevURLs
 * [coder users](coder_users.md)	 - Interact with Coder user accounts
-* [coder ws](coder_ws.md)	 - Interact with Coder workspaces
-
+* [coder workspaces](coder_workspaces.md)	 - Interact with Coder workspaces
diff --git a/docs/coder_ws.md b/docs/coder_ws.md
@@ -1,4 +1,4 @@
-## coder ws
+## coder workspaces
 
 Interact with Coder workspaces
 
@@ -9,7 +9,7 @@ Perform operations on the Coder workspaces owned by the active user.
 ### Options
 
 ```
-  -h, --help   help for ws
+  -h, --help   help for workspaces
 ```
 
 ### Options inherited from parent commands
@@ -21,12 +21,11 @@ Perform operations on the Coder workspaces owned by the active user.
 ### SEE ALSO
 
 * [coder](coder.md)	 - coder provides a CLI for working with an existing Coder installation
-* [coder ws create](coder_ws_create.md)	 - create a new workspace.
-* [coder ws create-from-config](coder_ws_create-from-config.md)	 - create a new workspace from a template
-* [coder ws edit](coder_ws_edit.md)	 - edit an existing workspace and initiate a rebuild.
-* [coder ws ls](coder_ws_ls.md)	 - list all workspaces owned by the active user
-* [coder ws rebuild](coder_ws_rebuild.md)	 - rebuild a Coder workspace
-* [coder ws rm](coder_ws_rm.md)	 - remove Coder workspaces by name
-* [coder ws stop](coder_ws_stop.md)	 - stop Coder workspaces by name
-* [coder ws watch-build](coder_ws_watch-build.md)	 - trail the build log of a Coder workspace
-
+* [coder workspaces create](coder_workspaces_create.md)	 - create a new workspace.
+* [coder workspaces create-from-config](coder_workspaces_create-from-config.md)	 - create a new workspace from a template
+* [coder workspaces edit](coder_workspaces_edit.md)	 - edit an existing workspace and initiate a rebuild.
+* [coder workspaces ls](coder_workspaces_ls.md)	 - list all workspaces owned by the active user
+* [coder workspaces rebuild](coder_workspaces_rebuild.md)	 - rebuild a Coder workspace
+* [coder workspaces rm](coder_workspaces_rm.md)	 - remove Coder workspaces by name
+* [coder workspaces stop](coder_workspaces_stop.md)	 - stop Coder workspaces by name
+* [coder workspaces watch-build](coder_workspaces_watch-build.md)	 - trail the build log of a Coder workspace
diff --git a/docs/coder_ws_create-from-config.md b/docs/coder_ws_create-from-config.md
@@ -1,4 +1,4 @@
-## coder ws create-from-config
+## coder workspaces create-from-config
 
 create a new workspace from a template
 
@@ -7,15 +7,15 @@ create a new workspace from a template
 Create a new Coder workspace using a Workspaces As Code template.
 
 ```
-coder ws create-from-config [flags]
+coder workspaces create-from-config [flags]
 ```
 
 ### Examples
 
 ```
 # create a new workspace from git repository
-coder ws create-from-config --name="dev-workspace" --repo-url https://github.com/cdr/m --ref my-branch
-coder ws create-from-config --name="dev-workspace" -f coder.yaml
+coder workspaces create-from-config --name="dev-workspace" --repo-url https://github.com/cdr/m --ref my-branch
+coder workspaces create-from-config --name="dev-workspace" -f coder.yaml
 ```
 
 ### Options
@@ -39,5 +39,4 @@ coder ws create-from-config --name="dev-workspace" -f coder.yaml
 
 ### SEE ALSO
 
-* [coder ws](coder_ws.md)	 - Interact with Coder workspaces
-
+* [coder workspaces](coder_workspaces.md)	 - Interact with Coder workspaces
diff --git a/docs/coder_ws_create.md b/docs/coder_ws_create.md
@@ -1,4 +1,4 @@
-## coder ws create
+## coder workspaces create
 
 create a new workspace.
 
@@ -7,15 +7,15 @@ create a new workspace.
 Create a new Coder workspace.
 
 ```
-coder ws create [workspace_name] [flags]
+coder workspaces create [workspace_name] [flags]
 ```
 
 ### Examples
 
 ```
 # create a new workspace using default resource amounts
-coder ws create my-new-workspace --image ubuntu
-coder ws create my-new-powerful-workspace --cpu 12 --disk 100 --memory 16 --image ubuntu
+coder workspaces create my-new-workspace --image ubuntu
+coder workspaces create my-new-powerful-workspace --cpu 12 --disk 100 --memory 16 --image ubuntu
 ```
 
 ### Options
@@ -43,5 +43,4 @@ coder ws create my-new-powerful-workspace --cpu 12 --disk 100 --memory 16 --imag
 
 ### SEE ALSO
 
-* [coder ws](coder_ws.md)	 - Interact with Coder workspaces
-
+* [coder workspaces](coder_workspaces.md)	 - Interact with Coder workspaces
diff --git a/docs/coder_ws_edit.md b/docs/coder_ws_edit.md
@@ -1,4 +1,4 @@
-## coder ws edit
+## coder workspaces edit
 
 edit an existing workspace and initiate a rebuild.
 
@@ -7,15 +7,15 @@ edit an existing workspace and initiate a rebuild.
 Edit an existing workspace and initate a rebuild.
 
 ```
-coder ws edit [flags]
+coder workspaces edit [flags]
 ```
 
 ### Examples
 
 ```
-coder ws edit back-end-workspace --cpu 4
+coder workspaces edit back-end-workspace --cpu 4
 
-coder ws edit back-end-workspace --disk 20
+coder workspaces edit back-end-workspace --disk 20
 ```
 
 ### Options
@@ -42,5 +42,4 @@ coder ws edit back-end-workspace --disk 20
 
 ### SEE ALSO
 
-* [coder ws](coder_ws.md)	 - Interact with Coder workspaces
-
+* [coder workspaces](coder_workspaces.md)	 - Interact with Coder workspaces
diff --git a/docs/coder_ws_ls.md b/docs/coder_ws_ls.md
@@ -1,4 +1,4 @@
-## coder ws ls
+## coder workspaces ls
 
 list all workspaces owned by the active user
 
@@ -7,7 +7,7 @@ list all workspaces owned by the active user
 List all Coder workspaces owned by the active user.
 
 ```
-coder ws ls [flags]
+coder workspaces ls [flags]
 ```
 
 ### Options
@@ -27,5 +27,4 @@ coder ws ls [flags]
 
 ### SEE ALSO
 
-* [coder ws](coder_ws.md)	 - Interact with Coder workspaces
-
+* [coder workspaces](coder_workspaces.md)	 - Interact with Coder workspaces
diff --git a/docs/coder_ws_rebuild.md b/docs/coder_ws_rebuild.md
@@ -1,16 +1,16 @@
-## coder ws rebuild
+## coder workspaces rebuild
 
 rebuild a Coder workspace
 
 ```
-coder ws rebuild [workspace_name] [flags]
+coder workspaces rebuild [workspace_name] [flags]
 ```
 
 ### Examples
 
 ```
-coder ws rebuild front-end-workspace --follow
-coder ws rebuild backend-workspace --force
+coder workspaces rebuild front-end-workspace --follow
+coder workspaces rebuild backend-workspace --force
 ```
 
 ### Options
@@ -30,5 +30,4 @@ coder ws rebuild backend-workspace --force
 
 ### SEE ALSO
 
-* [coder ws](coder_ws.md)	 - Interact with Coder workspaces
-
+* [coder workspaces](coder_workspaces.md)	 - Interact with Coder workspaces
diff --git a/docs/coder_ws_rm.md b/docs/coder_ws_rm.md
@@ -1,9 +1,9 @@
-## coder ws rm
+## coder workspaces rm
 
 remove Coder workspaces by name
 
 ```
-coder ws rm [...workspace_names] [flags]
+coder workspaces rm [...workspace_names] [flags]
 ```
 
 ### Options
@@ -22,5 +22,4 @@ coder ws rm [...workspace_names] [flags]
 
 ### SEE ALSO
 
-* [coder ws](coder_ws.md)	 - Interact with Coder workspaces
-
+* [coder workspaces](coder_workspaces.md)	 - Interact with Coder workspaces
diff --git a/docs/coder_ws_stop.md b/docs/coder_ws_stop.md
@@ -1,4 +1,4 @@
-## coder ws stop
+## coder workspaces stop
 
 stop Coder workspaces by name
 
@@ -7,22 +7,22 @@ stop Coder workspaces by name
 Stop Coder workspaces by name
 
 ```
-coder ws stop [...workspace_names] [flags]
+coder workspaces stop [...workspace_names] [flags]
 ```
 
 ### Examples
 
 ```
-coder ws stop front-end-workspace
-coder ws stop front-end-workspace backend-workspace
+coder workspaces stop front-end-workspace
+coder workspaces stop front-end-workspace backend-workspace
 
 # stop all of your workspaces
-coder ws ls -o json | jq -c '.[].name' | xargs coder ws stop
+coder workspaces ls -o json | jq -c '.[].name' | xargs coder workspaces stop
 
 # stop all workspaces for a given user
-coder ws --user charlie@coder.com ls -o json \
+coder workspaces --user charlie@coder.com ls -o json \
 	| jq -c '.[].name' \
-	| xargs coder ws --user charlie@coder.com stop
+	| xargs coder workspaces --user charlie@coder.com stop
 ```
 
 ### Options
@@ -40,5 +40,4 @@ coder ws --user charlie@coder.com ls -o json \
 
 ### SEE ALSO
 
-* [coder ws](coder_ws.md)	 - Interact with Coder workspaces
-
+* [coder workspaces](coder_workspaces.md)	 - Interact with Coder workspaces
diff --git a/docs/coder_ws_watch-build.md b/docs/coder_ws_watch-build.md
@@ -1,15 +1,15 @@
-## coder ws watch-build
+## coder workspaces watch-build
 
 trail the build log of a Coder workspace
 
 ```
-coder ws watch-build [workspace_name] [flags]
+coder workspaces watch-build [workspace_name] [flags]
 ```
 
 ### Examples
 
 ```
-coder ws watch-build front-end-workspace
+coder workspaces watch-build front-end-workspace
 ```
 
 ### Options
@@ -27,5 +27,4 @@ coder ws watch-build front-end-workspace
 
 ### SEE ALSO
 
-* [coder ws](coder_ws.md)	 - Interact with Coder workspaces
-
+* [coder workspaces](coder_workspaces.md)	 - Interact with Coder workspaces
diff --git a/internal/cmd/ceapi.go b/internal/cmd/ceapi.go
@@ -87,7 +87,7 @@ func findWorkspace(ctx context.Context, client coder.Client, workspaceName, user
 			"failed to find workspace",
 			fmt.Sprintf("workspace %q not found in %q", workspaceName, haystack),
 			clog.BlankLine,
-			clog.Tipf("run \"coder ws ls\" to view your workspaces"),
+			clog.Tipf("run \"coder workspaces ls\" to view your workspaces"),
 		)
 	}
 	return workspace, nil
diff --git a/internal/cmd/rebuild.go b/internal/cmd/rebuild.go
@@ -25,8 +25,8 @@ func rebuildWorkspaceCommand() *cobra.Command {
 		Use:   "rebuild [workspace_name]",
 		Short: "rebuild a Coder workspace",
 		Args:  xcobra.ExactArgs(1),
-		Example: `coder ws rebuild front-end-workspace --follow
-coder ws rebuild backend-workspace --force`,
+		Example: `coder workspaces rebuild front-end-workspace --follow
+coder workspaces rebuild backend-workspace --force`,
 		RunE: func(cmd *cobra.Command, args []string) error {
 			ctx := cmd.Context()
 			client, err := newClient(ctx, true)
@@ -61,7 +61,7 @@ coder ws rebuild backend-workspace --force`,
 			} else {
 				clog.LogSuccess(
 					"successfully started rebuild",
-					clog.Tipf("run \"coder ws watch-build %s\" to follow the build logs", workspace.Name),
+					clog.Tipf("run \"coder workspaces watch-build %s\" to follow the build logs", workspace.Name),
 				)
 			}
 			return nil
@@ -161,7 +161,7 @@ func watchBuildLogCommand() *cobra.Command {
 	var user string
 	cmd := &cobra.Command{
 		Use:     "watch-build [workspace_name]",
-		Example: "coder ws watch-build front-end-workspace",
+		Example: "coder workspaces watch-build front-end-workspace",
 		Short:   "trail the build log of a Coder workspace",
 		Args:    xcobra.ExactArgs(1),
 		RunE: func(cmd *cobra.Command, args []string) error {
diff --git a/internal/cmd/ssh.go b/internal/cmd/ssh.go
@@ -53,7 +53,7 @@ func shell(cmd *cobra.Command, args []string) error {
 		return clog.Error("workspace not available",
 			fmt.Sprintf("current status: \"%s\"", workspace.LatestStat.ContainerStatus),
 			clog.BlankLine,
-			clog.Tipf("use \"coder ws rebuild %s\" to rebuild this workspace", workspace.Name),
+			clog.Tipf("use \"coder workspaces rebuild %s\" to rebuild this workspace", workspace.Name),
 		)
 	}
 	wp, err := client.WorkspaceProviderByID(ctx, workspace.ResourcePoolID)
@@ -108,7 +108,7 @@ func shValidArgs(cmd *cobra.Command, args []string) error {
 			return clog.Error("missing [workspace_name] argument",
 				fmt.Sprintf("specify one of %q", haystack),
 				clog.BlankLine,
-				clog.Tipf("run \"coder ws ls\" to view your workspaces"),
+				clog.Tipf("run \"coder workspaces ls\" to view your workspaces"),
 			)
 		}
 		return clog.Error("missing [workspace_name] argument")
diff --git a/internal/cmd/workspaces.go b/internal/cmd/workspaces.go
diff --git a/internal/cmd/workspaces_test.go b/internal/cmd/workspaces_test.go

Original file line number	Diff line number	Diff line change
`@@ -53,15 +53,15 @@ func TestCoderCLI(t *testing.T) {`
`53`	`53`
`54`	`54`	`headlessLogin(ctx, t, c)`
`55`	`55`
`56`		`- c.Run(ctx, "coder ws").Assert(t,`
	`56`	`+ c.Run(ctx, "coder workspaces").Assert(t,`
`57`	`57`	`tcli.Success(),`
`58`	`58`	`)`
`59`	`59`
`60`		`- c.Run(ctx, "coder ws ls").Assert(t,`
	`60`	`+ c.Run(ctx, "coder workspaces ls").Assert(t,`
`61`	`61`	`tcli.Success(),`
`62`	`62`	`)`
`63`	`63`
`64`		`- c.Run(ctx, "coder ws ls -o json").Assert(t,`
	`64`	`+ c.Run(ctx, "coder workspaces ls -o json").Assert(t,`
`65`	`65`	`tcli.Success(),`
`66`	`66`	`)`
`67`	`67`
`@@ -93,7 +93,7 @@ func TestCoderCLI(t *testing.T) {`
`93`	`93`	`tcli.Success(),`
`94`	`94`	`)`
`95`	`95`
`96`		`- c.Run(ctx, "coder ws ls").Assert(t,`
	`96`	`+ c.Run(ctx, "coder workspaces ls").Assert(t,`
`97`	`97`	`tcli.Error(),`
`98`	`98`	`)`
`99`	`99`
Original file line number	Diff line number	Diff line change
`@@ -15,7 +15,7 @@ func TestSSH(t *testing.T) {`
`15`	`15`
`16`	`16`	`// TODO remove this once we can create a workspace if there aren't any`
`17`	`17`	`var workspaces []coder.Workspace`
`18`		`- c.Run(ctx, "coder ws ls --output json").Assert(t,`
	`18`	`+ c.Run(ctx, "coder workspaces ls --output json").Assert(t,`
`19`	`19`	`tcli.Success(),`
`20`	`20`	`tcli.StdoutJSONUnmarshal(&workspaces),`
`21`	`21`	`)`
Original file line number	Diff line number	Diff line change
`@@ -35,15 +35,15 @@ func TestStaticAuth(t *testing.T) {`
`35`	`35`
`36`	`36`	`// make requests with token environment variable authentication`
`37`	`37`	`cmd := exec.CommandContext(ctx, "sh", "-c",`
`38`		`- fmt.Sprintf("export CODER_URL=%s && export CODER_TOKEN=$(cat) && coder ws ls", os.Getenv("CODER_URL")),`
	`38`	`+ fmt.Sprintf("export CODER_URL=%s && export CODER_TOKEN=$(cat) && coder workspaces ls", os.Getenv("CODER_URL")),`
`39`	`39`	`)`
`40`	`40`	`cmd.Stdin = strings.NewReader(string(result.Stdout))`
`41`	`41`	`c.RunCmd(cmd).Assert(t,`
`42`	`42`	`tcli.Success(),`
`43`	`43`	`)`
`44`	`44`
`45`	`45`	`// should error when the environment variables aren't set`
`46`		`- c.Run(ctx, "coder ws ls").Assert(t,`
	`46`	`+ c.Run(ctx, "coder workspaces ls").Assert(t,`
`47`	`47`	`tcli.Error(),`
`48`	`48`	`)`
`49`	`49`	`})`