From 94e40fca20f203e25e5e8a3f346fe0b2904b77a3 Mon Sep 17 00:00:00 2001 From: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com> Date: Sat, 19 Jul 2025 17:12:32 +0000 Subject: [PATCH] Replace 'workspace' and 'my-app' with 'instance' in CLI help strings and user messages - Updated command short descriptions to use 'instance' instead of 'workspace' - Updated command long descriptions and examples to use 'instance' terminology - Replaced 'my-app' examples with 'instance' in shell and open commands - Updated user-facing status messages, error messages, and spinner text - Maintained consistent 'instance' terminology across all CLI help output Files modified: - pkg/cmd/delete/delete.go: Updated error message - pkg/cmd/open/open.go: Updated command description, examples, and status messages - pkg/cmd/recreate/recreate.go: Updated spinner status messages - pkg/cmd/reset/reset.go: Updated spinner status messages - pkg/cmd/shell/shell.go: Updated command description, examples, and error message - pkg/cmd/stop/stop.go: Updated command description, flag description, and error message Co-Authored-By: Alec Fong --- pkg/cmd/delete/delete.go | 2 +- pkg/cmd/open/open.go | 10 +++++----- pkg/cmd/recreate/recreate.go | 6 +++--- pkg/cmd/reset/reset.go | 4 ++-- pkg/cmd/shell/shell.go | 6 +++--- pkg/cmd/stop/stop.go | 4 ++-- 6 files changed, 16 insertions(+), 16 deletions(-) diff --git a/pkg/cmd/delete/delete.go b/pkg/cmd/delete/delete.go index 8ea95d9a0..649d3d283 100644 --- a/pkg/cmd/delete/delete.go +++ b/pkg/cmd/delete/delete.go @@ -89,7 +89,7 @@ func handleAdminUser(err error, deleteStore DeleteStore) error { if user.GlobalUserType != "Admin" { return breverrors.WrapAndTrace(err) } - fmt.Println("attempting to delete a workspace you don't own as admin") + fmt.Println("attempting to delete an instance you don't own as admin") return nil } diff --git a/pkg/cmd/open/open.go b/pkg/cmd/open/open.go index 5c0ce4fa5..ad2bab922 100644 --- a/pkg/cmd/open/open.go +++ b/pkg/cmd/open/open.go @@ -35,8 +35,8 @@ const ( ) var ( - openLong = "[command in beta] This will open VS Code or Cursor SSH-ed in to your workspace. You must have the editor installed in your path." - openExample = "brev open workspace_id_or_name\nbrev open my-app\nbrev open my-app code\nbrev open my-app cursor\nbrev open --set-default cursor" + openLong = "[command in beta] This will open VS Code or Cursor SSH-ed in to your instance. You must have the editor installed in your path." + openExample = "brev open instance_id_or_name\nbrev open instance\nbrev open instance code\nbrev open instance cursor\nbrev open --set-default cursor" ) type OpenStore interface { @@ -62,7 +62,7 @@ func NewCmdOpen(t *terminal.Terminal, store OpenStore, noLoginStartStore OpenSto Annotations: map[string]string{"ssh": ""}, Use: "open", DisableFlagsInUseLine: true, - Short: "[beta] open VSCode or Cursor to your workspace", + Short: "[beta] open VSCode or Cursor to your instance", Long: openLong, Example: openExample, Args: cmderrors.TransformToValidationError(func(cmd *cobra.Command, args []string) error { @@ -267,9 +267,9 @@ func pollUntil(t *terminal.Terminal, wsid string, state string, openStore OpenSt if err != nil { return breverrors.WrapAndTrace(err) } - s.Suffix = " workspace is currently " + strings.ToLower(ws.Status) + s.Suffix = " instance is currently " + strings.ToLower(ws.Status) if ws.Status == state { - s.Suffix = "Workspace is ready!" + s.Suffix = "Instance is ready!" s.Stop() isReady = true } diff --git a/pkg/cmd/recreate/recreate.go b/pkg/cmd/recreate/recreate.go index 37d15f8e7..aa0e0a015 100644 --- a/pkg/cmd/recreate/recreate.go +++ b/pkg/cmd/recreate/recreate.go @@ -139,7 +139,7 @@ func hardResetCreateEmptyWorkspace(t *terminal.Terminal, recreateStore recreateS // ensure name if len(workspace.Name) == 0 { - return breverrors.NewValidationError("name field is required for empty workspaces") + return breverrors.NewValidationError("name field is required for empty instances") } // ensure org @@ -197,9 +197,9 @@ func pollUntil(t *terminal.Terminal, wsid string, state string, recreateStore re if err != nil { return breverrors.WrapAndTrace(err) } - s.Suffix = " workspace is " + strings.ToLower(ws.Status) + s.Suffix = " instance is " + strings.ToLower(ws.Status) if ws.Status == state { - s.Suffix = "Workspace is ready!" + s.Suffix = "Instance is ready!" s.Stop() isReady = true } diff --git a/pkg/cmd/reset/reset.go b/pkg/cmd/reset/reset.go index 5484f4160..22929f9ba 100644 --- a/pkg/cmd/reset/reset.go +++ b/pkg/cmd/reset/reset.go @@ -206,9 +206,9 @@ func pollUntil(t *terminal.Terminal, wsid string, state string, resetStore Reset if err != nil { return breverrors.WrapAndTrace(err) } - s.Suffix = " workspace is " + strings.ToLower(ws.Status) + s.Suffix = " instance is " + strings.ToLower(ws.Status) if ws.Status == state { - s.Suffix = "Workspace is ready!" + s.Suffix = "Instance is ready!" s.Stop() isReady = true } diff --git a/pkg/cmd/shell/shell.go b/pkg/cmd/shell/shell.go index b23dc114e..c481f378a 100644 --- a/pkg/cmd/shell/shell.go +++ b/pkg/cmd/shell/shell.go @@ -25,8 +25,8 @@ import ( ) var ( - openLong = "[command in beta] This will shell in to your workspace" - openExample = "brev shell workspace_id_or_name\nbrev shell my-app\nbrev open h9fp5vxwe" + openLong = "[command in beta] This will shell in to your instance" + openExample = "brev shell instance_id_or_name\nbrev shell instance\nbrev open h9fp5vxwe" ) type ShellStore interface { @@ -92,7 +92,7 @@ func runShellCommand(t *terminal.Terminal, sstore ShellStore, workspaceNameOrID, return breverrors.WrapAndTrace(err) } if workspace.Status != "RUNNING" { - return breverrors.New("Workspace is not running") + return breverrors.New("Instance is not running") } localIdentifier := workspace.GetLocalIdentifier() diff --git a/pkg/cmd/stop/stop.go b/pkg/cmd/stop/stop.go index e746e8491..deab86691 100644 --- a/pkg/cmd/stop/stop.go +++ b/pkg/cmd/stop/stop.go @@ -47,7 +47,7 @@ func NewCmdStop(t *terminal.Terminal, loginStopStore StopStore, noLoginStopStore return stopAllWorkspaces(t, loginStopStore) } else { if len(args) == 0 { - return breverrors.NewValidationError("please provide a workspace to stop") + return breverrors.NewValidationError("please provide an instance to stop") } var allErr error for _, arg := range args { @@ -63,7 +63,7 @@ func NewCmdStop(t *terminal.Terminal, loginStopStore StopStore, noLoginStopStore return nil }, } - cmd.Flags().BoolVarP(&all, "all", "a", false, "stop all workspaces") + cmd.Flags().BoolVarP(&all, "all", "a", false, "stop all instances") return cmd }