Skip to content

Commit 0ded64f

Browse files
devin-ai-integration[bot]theFong
devin-ai-integration[bot]
and
theFong
committed
Update help documentation to use consistent 'instance' terminology
- Change 'workspace' to 'instance' in help strings and examples - Change 'my-app' to 'my-instance' in command examples - Update documentation files to use consistent terminology - Affects pkg/cmd/open/open.go, pkg/cmd/shell/shell.go, and .md files Co-Authored-By: Alec Fong <alecsanf@usc.edu>
1 parent 53896a9 commit 0ded64f

5 files changed

Lines changed: 89 additions & 89 deletions

File tree

‎pkg/cmd/create/doc.md‎

Lines changed: 28 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -53,10 +53,10 @@ you can safely ctrl+c to exit
5353
⣽ workspace is deploying
5454
your workspace is ready!
5555
56-
connect to the workspace:
57-
brev open foo # brev open <name> -> open workspace in preferred editor
58-
brev shell foo # brev shell <name> -> ssh into workspace (shortcut)
59-
ssh foo-8j4u # ssh <ssh-name> -> ssh directly to workspace
56+
connect to the instance:
57+
brev open foo # brev open <name> -> open instance in preferred editor
58+
brev shell foo # brev shell <name> -> ssh into instance (shortcut)
59+
ssh foo-8j4u # ssh <ssh-name> -> ssh directly to instance
6060
6161
```
6262

@@ -79,10 +79,10 @@ you can safely ctrl+c to exit
7979
⣽ workspace is deploying
8080
your workspace is ready!
8181
82-
connect to the workspace:
83-
brev open foo # brev open <name> -> open workspace in preferred editor
84-
brev shell foo # brev shell <name> -> ssh into workspace (shortcut)
85-
ssh foo-8j4u # ssh <ssh-name> -> ssh directly to workspace
82+
connect to the instance:
83+
brev open foo # brev open <name> -> open instance in preferred editor
84+
brev shell foo # brev shell <name> -> ssh into instance (shortcut)
85+
ssh foo-8j4u # ssh <ssh-name> -> ssh directly to instance
8686
8787
```
8888

@@ -136,10 +136,10 @@ You can safely ctrl+c to exit
136136
⡿ workspace is deploying
137137
Your workspace is ready!
138138
139-
Connect to the workspace:
140-
brev open merge-json # brev open <NAME> -> open workspace in preferred editor
141-
brev shell merge-json # brev shell <NAME> -> ssh into workspace (shortcut)
142-
ssh merge-json-wd6q # ssh <SSH-NAME> -> ssh directly to workspace
139+
Connect to the instance:
140+
brev open merge-json # brev open <NAME> -> open instance in preferred editor
141+
brev shell merge-json # brev shell <NAME> -> ssh into instance (shortcut)
142+
ssh merge-json-wd6q # ssh <SSH-NAME> -> ssh directly to instance
143143
```
144144

145145
### Create a workspace from a git repository
@@ -161,10 +161,10 @@ You can safely ctrl+c to exit
161161
⣾ workspace is deploying
162162
Your workspace is ready!
163163
164-
Connect to the workspace:
165-
brev open react-starter-app # brev open <NAME> -> open workspace in preferred editor
166-
brev shell react-starter-app # brev shell <NAME> -> ssh into workspace (shortcut)
167-
ssh react-starter-app-8v8p # ssh <SSH-NAME> -> ssh directly to workspace
164+
Connect to the instance:
165+
brev open react-starter-app # brev open <NAME> -> open instance in preferred editor
166+
brev shell react-starter-app # brev shell <NAME> -> ssh into instance (shortcut)
167+
ssh react-starter-app-8v8p # ssh <SSH-NAME> -> ssh directly to instance
168168
169169
```
170170

@@ -184,10 +184,10 @@ You have 1 workspace in Org brev.dev
184184
NAME STATUS URL ID
185185
brev-cli RUNNING brev-cli-p09m-brevdev.wgt-us-west-2-test.brev.dev x1yxqp09m
186186
187-
Connect to running workspace:
188-
brev open brev-cli # brev open <NAME> -> open workspace in preferred editor
189-
brev shell brev-cli # brev shell <NAME> -> ssh into workspace (shortcut)
190-
ssh brev-cli-p09m # ssh <SSH-NAME> -> ssh directly to workspace
187+
Connect to running instance:
188+
brev open brev-cli # brev open <NAME> -> open instance in preferred editor
189+
brev shell brev-cli # brev shell <NAME> -> ssh into instance (shortcut)
190+
ssh brev-cli-p09m # ssh <SSH-NAME> -> ssh directly to instance
191191
192192
7 other projects in Org brev.dev
193193
NAME MEMBERS
@@ -221,10 +221,10 @@ template 4nbb4lg2s ubuntu
221221
resource class 2x8
222222
workspace group brev-test-brevtenant-cluster
223223
You can safely ctrl+c to exit
224-
⣟ workspace is deploying Connect to the workspace:
225-
brev open new-docs # brev open <NAME> -> open workspace in preferred editor
226-
brev shell new-docs # brev shell <NAME> -> ssh into workspace (shortcut)
227-
ssh new-docs-pek9 # ssh <SSH-NAME> -> ssh directly to workspace
224+
⣟ workspace is deploying Connect to the instance:
225+
brev open new-docs # brev open <NAME> -> open instance in preferred editor
226+
brev shell new-docs # brev shell <NAME> -> ssh into instance (shortcut)
227+
ssh new-docs-pek9 # ssh <SSH-NAME> -> ssh directly to instance
228228
```
229229

230230
### Start a stopped workspace
@@ -245,10 +245,10 @@ You have 1 workspace in Org brev.dev
245245
NAME STATUS URL ID
246246
linear-client STOPPED linear-client-yw1a-brevdev.wgt-us-west-2-test.brev.dev gov5jyw1a
247247
248-
Connect to running workspace:
249-
brev open linear-client # brev open <NAME> -> open workspace in preferred editor
250-
brev shell linear-client # brev shell <NAME> -> ssh into workspace (shortcut)
251-
ssh linear-client-yw1a # ssh <SSH-NAME> -> ssh directly to workspace
248+
Connect to running instance:
249+
brev open linear-client # brev open <NAME> -> open instance in preferred editor
250+
brev shell linear-client # brev shell <NAME> -> ssh into instance (shortcut)
251+
ssh linear-client-yw1a # ssh <SSH-NAME> -> ssh directly to instance
252252
253253
```
254254

‎pkg/cmd/open/open.go‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -35,8 +35,8 @@ const (
3535
)
3636

3737
var (
38-
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."
39-
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"
38+
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."
39+
openExample = "brev open instance_id_or_name\nbrev open my-instance\nbrev open my-instance code\nbrev open my-instance cursor\nbrev open --set-default cursor"
4040
)
4141

4242
type OpenStore interface {
@@ -62,7 +62,7 @@ func NewCmdOpen(t *terminal.Terminal, store OpenStore, noLoginStartStore OpenSto
6262
Annotations: map[string]string{"ssh": ""},
6363
Use: "open",
6464
DisableFlagsInUseLine: true,
65-
Short: "[beta] open VSCode or Cursor to your workspace",
65+
Short: "[beta] open VSCode or Cursor to your instance",
6666
Long: openLong,
6767
Example: openExample,
6868
Args: cmderrors.TransformToValidationError(func(cmd *cobra.Command, args []string) error {

‎pkg/cmd/shell/shell.go‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,8 @@ import (
2525
)
2626

2727
var (
28-
openLong = "[command in beta] This will shell in to your workspace"
29-
openExample = "brev shell workspace_id_or_name\nbrev shell my-app\nbrev open h9fp5vxwe"
28+
openLong = "[command in beta] This will shell in to your instance"
29+
openExample = "brev shell instance_id_or_name\nbrev shell my-instance\nbrev open h9fp5vxwe"
3030
)
3131

3232
type ShellStore interface {

‎pkg/cmd/start/doc.md‎

Lines changed: 28 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -53,10 +53,10 @@ you can safely ctrl+c to exit
5353
⣽ workspace is deploying
5454
your workspace is ready!
5555
56-
connect to the workspace:
57-
brev open foo # brev open <name> -> open workspace in preferred editor
58-
brev shell foo # brev shell <name> -> ssh into workspace (shortcut)
59-
ssh foo-8j4u # ssh <ssh-name> -> ssh directly to workspace
56+
connect to the instance:
57+
brev open foo # brev open <name> -> open instance in preferred editor
58+
brev shell foo # brev shell <name> -> ssh into instance (shortcut)
59+
ssh foo-8j4u # ssh <ssh-name> -> ssh directly to instance
6060
6161
```
6262

@@ -79,10 +79,10 @@ you can safely ctrl+c to exit
7979
⣽ workspace is deploying
8080
your workspace is ready!
8181
82-
connect to the workspace:
83-
brev open foo # brev open <name> -> open workspace in preferred editor
84-
brev shell foo # brev shell <name> -> ssh into workspace (shortcut)
85-
ssh foo-8j4u # ssh <ssh-name> -> ssh directly to workspace
82+
connect to the instance:
83+
brev open foo # brev open <name> -> open instance in preferred editor
84+
brev shell foo # brev shell <name> -> ssh into instance (shortcut)
85+
ssh foo-8j4u # ssh <ssh-name> -> ssh directly to instance
8686
8787
```
8888

@@ -136,10 +136,10 @@ You can safely ctrl+c to exit
136136
⡿ workspace is deploying
137137
Your workspace is ready!
138138
139-
Connect to the workspace:
140-
brev open merge-json # brev open <NAME> -> open workspace in preferred editor
141-
brev shell merge-json # brev shell <NAME> -> ssh into workspace (shortcut)
142-
ssh merge-json-wd6q # ssh <SSH-NAME> -> ssh directly to workspace
139+
Connect to the instance:
140+
brev open merge-json # brev open <NAME> -> open instance in preferred editor
141+
brev shell merge-json # brev shell <NAME> -> ssh into instance (shortcut)
142+
ssh merge-json-wd6q # ssh <SSH-NAME> -> ssh directly to instance
143143
```
144144

145145
### Create a workspace from a git repository
@@ -161,10 +161,10 @@ You can safely ctrl+c to exit
161161
⣾ workspace is deploying
162162
Your workspace is ready!
163163
164-
Connect to the workspace:
165-
brev open react-starter-app # brev open <NAME> -> open workspace in preferred editor
166-
brev shell react-starter-app # brev shell <NAME> -> ssh into workspace (shortcut)
167-
ssh react-starter-app-8v8p # ssh <SSH-NAME> -> ssh directly to workspace
164+
Connect to the instance:
165+
brev open react-starter-app # brev open <NAME> -> open instance in preferred editor
166+
brev shell react-starter-app # brev shell <NAME> -> ssh into instance (shortcut)
167+
ssh react-starter-app-8v8p # ssh <SSH-NAME> -> ssh directly to instance
168168
169169
```
170170

@@ -184,10 +184,10 @@ You have 1 workspace in Org brev.dev
184184
NAME STATUS URL ID
185185
brev-cli RUNNING brev-cli-p09m-brevdev.wgt-us-west-2-test.brev.dev x1yxqp09m
186186
187-
Connect to running workspace:
188-
brev open brev-cli # brev open <NAME> -> open workspace in preferred editor
189-
brev shell brev-cli # brev shell <NAME> -> ssh into workspace (shortcut)
190-
ssh brev-cli-p09m # ssh <SSH-NAME> -> ssh directly to workspace
187+
Connect to running instance:
188+
brev open brev-cli # brev open <NAME> -> open instance in preferred editor
189+
brev shell brev-cli # brev shell <NAME> -> ssh into instance (shortcut)
190+
ssh brev-cli-p09m # ssh <SSH-NAME> -> ssh directly to instance
191191
192192
7 other projects in Org brev.dev
193193
NAME MEMBERS
@@ -221,10 +221,10 @@ template 4nbb4lg2s ubuntu
221221
resource class 2x8
222222
workspace group brev-test-brevtenant-cluster
223223
You can safely ctrl+c to exit
224-
⣟ workspace is deploying Connect to the workspace:
225-
brev open new-docs # brev open <NAME> -> open workspace in preferred editor
226-
brev shell new-docs # brev shell <NAME> -> ssh into workspace (shortcut)
227-
ssh new-docs-pek9 # ssh <SSH-NAME> -> ssh directly to workspace
224+
⣟ workspace is deploying Connect to the instance:
225+
brev open new-docs # brev open <NAME> -> open instance in preferred editor
226+
brev shell new-docs # brev shell <NAME> -> ssh into instance (shortcut)
227+
ssh new-docs-pek9 # ssh <SSH-NAME> -> ssh directly to instance
228228
```
229229

230230
### Start a stopped workspace
@@ -245,10 +245,10 @@ You have 1 workspace in Org brev.dev
245245
NAME STATUS URL ID
246246
linear-client STOPPED linear-client-yw1a-brevdev.wgt-us-west-2-test.brev.dev gov5jyw1a
247247
248-
Connect to running workspace:
249-
brev open linear-client # brev open <NAME> -> open workspace in preferred editor
250-
brev shell linear-client # brev shell <NAME> -> ssh into workspace (shortcut)
251-
ssh linear-client-yw1a # ssh <SSH-NAME> -> ssh directly to workspace
248+
Connect to running instance:
249+
brev open linear-client # brev open <NAME> -> open instance in preferred editor
250+
brev shell linear-client # brev shell <NAME> -> ssh into instance (shortcut)
251+
ssh linear-client-yw1a # ssh <SSH-NAME> -> ssh directly to instance
252252
253253
```
254254

‎pkg/cmd/status/doc.md‎

Lines changed: 28 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -53,10 +53,10 @@ you can safely ctrl+c to exit
5353
⣽ workspace is deploying
5454
your workspace is ready!
5555
56-
connect to the workspace:
57-
brev open foo # brev open <name> -> open workspace in preferred editor
58-
brev shell foo # brev shell <name> -> ssh into workspace (shortcut)
59-
ssh foo-8j4u # ssh <ssh-name> -> ssh directly to workspace
56+
connect to the instance:
57+
brev open foo # brev open <name> -> open instance in preferred editor
58+
brev shell foo # brev shell <name> -> ssh into instance (shortcut)
59+
ssh foo-8j4u # ssh <ssh-name> -> ssh directly to instance
6060
6161
```
6262

@@ -79,10 +79,10 @@ you can safely ctrl+c to exit
7979
⣽ workspace is deploying
8080
your workspace is ready!
8181
82-
connect to the workspace:
83-
brev open foo # brev open <name> -> open workspace in preferred editor
84-
brev shell foo # brev shell <name> -> ssh into workspace (shortcut)
85-
ssh foo-8j4u # ssh <ssh-name> -> ssh directly to workspace
82+
connect to the instance:
83+
brev open foo # brev open <name> -> open instance in preferred editor
84+
brev shell foo # brev shell <name> -> ssh into instance (shortcut)
85+
ssh foo-8j4u # ssh <ssh-name> -> ssh directly to instance
8686
8787
```
8888

@@ -136,10 +136,10 @@ You can safely ctrl+c to exit
136136
⡿ workspace is deploying
137137
Your workspace is ready!
138138
139-
Connect to the workspace:
140-
brev open merge-json # brev open <NAME> -> open workspace in preferred editor
141-
brev shell merge-json # brev shell <NAME> -> ssh into workspace (shortcut)
142-
ssh merge-json-wd6q # ssh <SSH-NAME> -> ssh directly to workspace
139+
Connect to the instance:
140+
brev open merge-json # brev open <NAME> -> open instance in preferred editor
141+
brev shell merge-json # brev shell <NAME> -> ssh into instance (shortcut)
142+
ssh merge-json-wd6q # ssh <SSH-NAME> -> ssh directly to instance
143143
```
144144

145145
### Create a workspace from a git repository
@@ -161,10 +161,10 @@ You can safely ctrl+c to exit
161161
⣾ workspace is deploying
162162
Your workspace is ready!
163163
164-
Connect to the workspace:
165-
brev open react-starter-app # brev open <NAME> -> open workspace in preferred editor
166-
brev shell react-starter-app # brev shell <NAME> -> ssh into workspace (shortcut)
167-
ssh react-starter-app-8v8p # ssh <SSH-NAME> -> ssh directly to workspace
164+
Connect to the instance:
165+
brev open react-starter-app # brev open <NAME> -> open instance in preferred editor
166+
brev shell react-starter-app # brev shell <NAME> -> ssh into instance (shortcut)
167+
ssh react-starter-app-8v8p # ssh <SSH-NAME> -> ssh directly to instance
168168
169169
```
170170

@@ -184,10 +184,10 @@ You have 1 workspace in Org brev.dev
184184
NAME STATUS URL ID
185185
brev-cli RUNNING brev-cli-p09m-brevdev.wgt-us-west-2-test.brev.dev x1yxqp09m
186186
187-
Connect to running workspace:
188-
brev open brev-cli # brev open <NAME> -> open workspace in preferred editor
189-
brev shell brev-cli # brev shell <NAME> -> ssh into workspace (shortcut)
190-
ssh brev-cli-p09m # ssh <SSH-NAME> -> ssh directly to workspace
187+
Connect to running instance:
188+
brev open brev-cli # brev open <NAME> -> open instance in preferred editor
189+
brev shell brev-cli # brev shell <NAME> -> ssh into instance (shortcut)
190+
ssh brev-cli-p09m # ssh <SSH-NAME> -> ssh directly to instance
191191
192192
7 other projects in Org brev.dev
193193
NAME MEMBERS
@@ -221,10 +221,10 @@ template 4nbb4lg2s ubuntu
221221
resource class 2x8
222222
workspace group brev-test-brevtenant-cluster
223223
You can safely ctrl+c to exit
224-
⣟ workspace is deploying Connect to the workspace:
225-
brev open new-docs # brev open <NAME> -> open workspace in preferred editor
226-
brev shell new-docs # brev shell <NAME> -> ssh into workspace (shortcut)
227-
ssh new-docs-pek9 # ssh <SSH-NAME> -> ssh directly to workspace
224+
⣟ workspace is deploying Connect to the instance:
225+
brev open new-docs # brev open <NAME> -> open instance in preferred editor
226+
brev shell new-docs # brev shell <NAME> -> ssh into instance (shortcut)
227+
ssh new-docs-pek9 # ssh <SSH-NAME> -> ssh directly to instance
228228
```
229229

230230
### Start a stopped workspace
@@ -245,10 +245,10 @@ You have 1 workspace in Org brev.dev
245245
NAME STATUS URL ID
246246
linear-client STOPPED linear-client-yw1a-brevdev.wgt-us-west-2-test.brev.dev gov5jyw1a
247247
248-
Connect to running workspace:
249-
brev open linear-client # brev open <NAME> -> open workspace in preferred editor
250-
brev shell linear-client # brev shell <NAME> -> ssh into workspace (shortcut)
251-
ssh linear-client-yw1a # ssh <SSH-NAME> -> ssh directly to workspace
248+
Connect to running instance:
249+
brev open linear-client # brev open <NAME> -> open instance in preferred editor
250+
brev shell linear-client # brev shell <NAME> -> ssh into instance (shortcut)
251+
ssh linear-client-yw1a # ssh <SSH-NAME> -> ssh directly to instance
252252
253253
```
254254

0 commit comments

Comments
 (0)