Skip to content

Update help documentation to use consistent 'instance' terminology #239

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
devin-ai-integration wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update help documentation to use consistent 'instance' terminology #239

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
56 changes: 28 additions & 28 deletions pkg/cmd/create/doc.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,10 +53,10 @@ you can safely ctrl+c to exit
⣽ workspace is deploying
your workspace is ready!

connect to the workspace:
brev open foo # brev open <name> -> open workspace in preferred editor
brev shell foo # brev shell <name> -> ssh into workspace (shortcut)
ssh foo-8j4u # ssh <ssh-name> -> ssh directly to workspace
connect to the instance:
brev open foo # brev open <name> -> open instance in preferred editor
brev shell foo # brev shell <name> -> ssh into instance (shortcut)
ssh foo-8j4u # ssh <ssh-name> -> ssh directly to instance

```

Expand All @@ -79,10 +79,10 @@ you can safely ctrl+c to exit
⣽ workspace is deploying
your workspace is ready!

connect to the workspace:
brev open foo # brev open <name> -> open workspace in preferred editor
brev shell foo # brev shell <name> -> ssh into workspace (shortcut)
ssh foo-8j4u # ssh <ssh-name> -> ssh directly to workspace
connect to the instance:
brev open foo # brev open <name> -> open instance in preferred editor
brev shell foo # brev shell <name> -> ssh into instance (shortcut)
ssh foo-8j4u # ssh <ssh-name> -> ssh directly to instance

```

Expand Down Expand Up @@ -136,10 +136,10 @@ You can safely ctrl+c to exit
⡿ workspace is deploying
Your workspace is ready!

Connect to the workspace:
brev open merge-json # brev open <NAME> -> open workspace in preferred editor
brev shell merge-json # brev shell <NAME> -> ssh into workspace (shortcut)
ssh merge-json-wd6q # ssh <SSH-NAME> -> ssh directly to workspace
Connect to the instance:
brev open merge-json # brev open <NAME> -> open instance in preferred editor
brev shell merge-json # brev shell <NAME> -> ssh into instance (shortcut)
ssh merge-json-wd6q # ssh <SSH-NAME> -> ssh directly to instance
```

### Create a workspace from a git repository
Expand All @@ -161,10 +161,10 @@ You can safely ctrl+c to exit
⣾ workspace is deploying
Your workspace is ready!

Connect to the workspace:
brev open react-starter-app # brev open <NAME> -> open workspace in preferred editor
brev shell react-starter-app # brev shell <NAME> -> ssh into workspace (shortcut)
ssh react-starter-app-8v8p # ssh <SSH-NAME> -> ssh directly to workspace
Connect to the instance:
brev open react-starter-app # brev open <NAME> -> open instance in preferred editor
brev shell react-starter-app # brev shell <NAME> -> ssh into instance (shortcut)
ssh react-starter-app-8v8p # ssh <SSH-NAME> -> ssh directly to instance

```

Expand All @@ -184,10 +184,10 @@ You have 1 workspace in Org brev.dev
NAME STATUS URL ID
brev-cli RUNNING brev-cli-p09m-brevdev.wgt-us-west-2-test.brev.dev x1yxqp09m

Connect to running workspace:
brev open brev-cli # brev open <NAME> -> open workspace in preferred editor
brev shell brev-cli # brev shell <NAME> -> ssh into workspace (shortcut)
ssh brev-cli-p09m # ssh <SSH-NAME> -> ssh directly to workspace
Connect to running instance:
brev open brev-cli # brev open <NAME> -> open instance in preferred editor
brev shell brev-cli # brev shell <NAME> -> ssh into instance (shortcut)
ssh brev-cli-p09m # ssh <SSH-NAME> -> ssh directly to instance

7 other projects in Org brev.dev
NAME MEMBERS
Expand Down Expand Up @@ -221,10 +221,10 @@ template 4nbb4lg2s ubuntu
resource class 2x8
workspace group brev-test-brevtenant-cluster
You can safely ctrl+c to exit
⣟ workspace is deploying Connect to the workspace:
brev open new-docs # brev open <NAME> -> open workspace in preferred editor
brev shell new-docs # brev shell <NAME> -> ssh into workspace (shortcut)
ssh new-docs-pek9 # ssh <SSH-NAME> -> ssh directly to workspace
⣟ workspace is deploying Connect to the instance:
brev open new-docs # brev open <NAME> -> open instance in preferred editor
brev shell new-docs # brev shell <NAME> -> ssh into instance (shortcut)
ssh new-docs-pek9 # ssh <SSH-NAME> -> ssh directly to instance
```

### Start a stopped workspace
Expand All @@ -245,10 +245,10 @@ You have 1 workspace in Org brev.dev
NAME STATUS URL ID
linear-client STOPPED linear-client-yw1a-brevdev.wgt-us-west-2-test.brev.dev gov5jyw1a

Connect to running workspace:
brev open linear-client # brev open <NAME> -> open workspace in preferred editor
brev shell linear-client # brev shell <NAME> -> ssh into workspace (shortcut)
ssh linear-client-yw1a # ssh <SSH-NAME> -> ssh directly to workspace
Connect to running instance:
brev open linear-client # brev open <NAME> -> open instance in preferred editor
brev shell linear-client # brev shell <NAME> -> ssh into instance (shortcut)
ssh linear-client-yw1a # ssh <SSH-NAME> -> ssh directly to instance

```

Expand Down
6 changes: 3 additions & 3 deletions pkg/cmd/open/open.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 my-instance\nbrev open my-instance code\nbrev open my-instance cursor\nbrev open --set-default cursor"
)

type OpenStore interface {
Expand All @@ -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 {
Expand Down
4 changes: 2 additions & 2 deletions pkg/cmd/shell/shell.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 my-instance\nbrev open h9fp5vxwe"
)

type ShellStore interface {
Expand Down
56 changes: 28 additions & 28 deletions pkg/cmd/start/doc.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,10 +53,10 @@ you can safely ctrl+c to exit
⣽ workspace is deploying
your workspace is ready!

connect to the workspace:
brev open foo # brev open <name> -> open workspace in preferred editor
brev shell foo # brev shell <name> -> ssh into workspace (shortcut)
ssh foo-8j4u # ssh <ssh-name> -> ssh directly to workspace
connect to the instance:
brev open foo # brev open <name> -> open instance in preferred editor
brev shell foo # brev shell <name> -> ssh into instance (shortcut)
ssh foo-8j4u # ssh <ssh-name> -> ssh directly to instance

```

Expand All @@ -79,10 +79,10 @@ you can safely ctrl+c to exit
⣽ workspace is deploying
your workspace is ready!

connect to the workspace:
brev open foo # brev open <name> -> open workspace in preferred editor
brev shell foo # brev shell <name> -> ssh into workspace (shortcut)
ssh foo-8j4u # ssh <ssh-name> -> ssh directly to workspace
connect to the instance:
brev open foo # brev open <name> -> open instance in preferred editor
brev shell foo # brev shell <name> -> ssh into instance (shortcut)
ssh foo-8j4u # ssh <ssh-name> -> ssh directly to instance

```

Expand Down Expand Up @@ -136,10 +136,10 @@ You can safely ctrl+c to exit
⡿ workspace is deploying
Your workspace is ready!

Connect to the workspace:
brev open merge-json # brev open <NAME> -> open workspace in preferred editor
brev shell merge-json # brev shell <NAME> -> ssh into workspace (shortcut)
ssh merge-json-wd6q # ssh <SSH-NAME> -> ssh directly to workspace
Connect to the instance:
brev open merge-json # brev open <NAME> -> open instance in preferred editor
brev shell merge-json # brev shell <NAME> -> ssh into instance (shortcut)
ssh merge-json-wd6q # ssh <SSH-NAME> -> ssh directly to instance
```

### Create a workspace from a git repository
Expand All @@ -161,10 +161,10 @@ You can safely ctrl+c to exit
⣾ workspace is deploying
Your workspace is ready!

Connect to the workspace:
brev open react-starter-app # brev open <NAME> -> open workspace in preferred editor
brev shell react-starter-app # brev shell <NAME> -> ssh into workspace (shortcut)
ssh react-starter-app-8v8p # ssh <SSH-NAME> -> ssh directly to workspace
Connect to the instance:
brev open react-starter-app # brev open <NAME> -> open instance in preferred editor
brev shell react-starter-app # brev shell <NAME> -> ssh into instance (shortcut)
ssh react-starter-app-8v8p # ssh <SSH-NAME> -> ssh directly to instance

```

Expand All @@ -184,10 +184,10 @@ You have 1 workspace in Org brev.dev
NAME STATUS URL ID
brev-cli RUNNING brev-cli-p09m-brevdev.wgt-us-west-2-test.brev.dev x1yxqp09m

Connect to running workspace:
brev open brev-cli # brev open <NAME> -> open workspace in preferred editor
brev shell brev-cli # brev shell <NAME> -> ssh into workspace (shortcut)
ssh brev-cli-p09m # ssh <SSH-NAME> -> ssh directly to workspace
Connect to running instance:
brev open brev-cli # brev open <NAME> -> open instance in preferred editor
brev shell brev-cli # brev shell <NAME> -> ssh into instance (shortcut)
ssh brev-cli-p09m # ssh <SSH-NAME> -> ssh directly to instance

7 other projects in Org brev.dev
NAME MEMBERS
Expand Down Expand Up @@ -221,10 +221,10 @@ template 4nbb4lg2s ubuntu
resource class 2x8
workspace group brev-test-brevtenant-cluster
You can safely ctrl+c to exit
⣟ workspace is deploying Connect to the workspace:
brev open new-docs # brev open <NAME> -> open workspace in preferred editor
brev shell new-docs # brev shell <NAME> -> ssh into workspace (shortcut)
ssh new-docs-pek9 # ssh <SSH-NAME> -> ssh directly to workspace
⣟ workspace is deploying Connect to the instance:
brev open new-docs # brev open <NAME> -> open instance in preferred editor
brev shell new-docs # brev shell <NAME> -> ssh into instance (shortcut)
ssh new-docs-pek9 # ssh <SSH-NAME> -> ssh directly to instance
```

### Start a stopped workspace
Expand All @@ -245,10 +245,10 @@ You have 1 workspace in Org brev.dev
NAME STATUS URL ID
linear-client STOPPED linear-client-yw1a-brevdev.wgt-us-west-2-test.brev.dev gov5jyw1a

Connect to running workspace:
brev open linear-client # brev open <NAME> -> open workspace in preferred editor
brev shell linear-client # brev shell <NAME> -> ssh into workspace (shortcut)
ssh linear-client-yw1a # ssh <SSH-NAME> -> ssh directly to workspace
Connect to running instance:
brev open linear-client # brev open <NAME> -> open instance in preferred editor
brev shell linear-client # brev shell <NAME> -> ssh into instance (shortcut)
ssh linear-client-yw1a # ssh <SSH-NAME> -> ssh directly to instance

```

Expand Down
56 changes: 28 additions & 28 deletions pkg/cmd/status/doc.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,10 +53,10 @@ you can safely ctrl+c to exit
⣽ workspace is deploying
your workspace is ready!

connect to the workspace:
brev open foo # brev open <name> -> open workspace in preferred editor
brev shell foo # brev shell <name> -> ssh into workspace (shortcut)
ssh foo-8j4u # ssh <ssh-name> -> ssh directly to workspace
connect to the instance:
brev open foo # brev open <name> -> open instance in preferred editor
brev shell foo # brev shell <name> -> ssh into instance (shortcut)
ssh foo-8j4u # ssh <ssh-name> -> ssh directly to instance

```

Expand All @@ -79,10 +79,10 @@ you can safely ctrl+c to exit
⣽ workspace is deploying
your workspace is ready!

connect to the workspace:
brev open foo # brev open <name> -> open workspace in preferred editor
brev shell foo # brev shell <name> -> ssh into workspace (shortcut)
ssh foo-8j4u # ssh <ssh-name> -> ssh directly to workspace
connect to the instance:
brev open foo # brev open <name> -> open instance in preferred editor
brev shell foo # brev shell <name> -> ssh into instance (shortcut)
ssh foo-8j4u # ssh <ssh-name> -> ssh directly to instance

```

Expand Down Expand Up @@ -136,10 +136,10 @@ You can safely ctrl+c to exit
⡿ workspace is deploying
Your workspace is ready!

Connect to the workspace:
brev open merge-json # brev open <NAME> -> open workspace in preferred editor
brev shell merge-json # brev shell <NAME> -> ssh into workspace (shortcut)
ssh merge-json-wd6q # ssh <SSH-NAME> -> ssh directly to workspace
Connect to the instance:
brev open merge-json # brev open <NAME> -> open instance in preferred editor
brev shell merge-json # brev shell <NAME> -> ssh into instance (shortcut)
ssh merge-json-wd6q # ssh <SSH-NAME> -> ssh directly to instance
```

### Create a workspace from a git repository
Expand All @@ -161,10 +161,10 @@ You can safely ctrl+c to exit
⣾ workspace is deploying
Your workspace is ready!

Connect to the workspace:
brev open react-starter-app # brev open <NAME> -> open workspace in preferred editor
brev shell react-starter-app # brev shell <NAME> -> ssh into workspace (shortcut)
ssh react-starter-app-8v8p # ssh <SSH-NAME> -> ssh directly to workspace
Connect to the instance:
brev open react-starter-app # brev open <NAME> -> open instance in preferred editor
brev shell react-starter-app # brev shell <NAME> -> ssh into instance (shortcut)
ssh react-starter-app-8v8p # ssh <SSH-NAME> -> ssh directly to instance

```

Expand All @@ -184,10 +184,10 @@ You have 1 workspace in Org brev.dev
NAME STATUS URL ID
brev-cli RUNNING brev-cli-p09m-brevdev.wgt-us-west-2-test.brev.dev x1yxqp09m

Connect to running workspace:
brev open brev-cli # brev open <NAME> -> open workspace in preferred editor
brev shell brev-cli # brev shell <NAME> -> ssh into workspace (shortcut)
ssh brev-cli-p09m # ssh <SSH-NAME> -> ssh directly to workspace
Connect to running instance:
brev open brev-cli # brev open <NAME> -> open instance in preferred editor
brev shell brev-cli # brev shell <NAME> -> ssh into instance (shortcut)
ssh brev-cli-p09m # ssh <SSH-NAME> -> ssh directly to instance

7 other projects in Org brev.dev
NAME MEMBERS
Expand Down Expand Up @@ -221,10 +221,10 @@ template 4nbb4lg2s ubuntu
resource class 2x8
workspace group brev-test-brevtenant-cluster
You can safely ctrl+c to exit
⣟ workspace is deploying Connect to the workspace:
brev open new-docs # brev open <NAME> -> open workspace in preferred editor
brev shell new-docs # brev shell <NAME> -> ssh into workspace (shortcut)
ssh new-docs-pek9 # ssh <SSH-NAME> -> ssh directly to workspace
⣟ workspace is deploying Connect to the instance:
brev open new-docs # brev open <NAME> -> open instance in preferred editor
brev shell new-docs # brev shell <NAME> -> ssh into instance (shortcut)
ssh new-docs-pek9 # ssh <SSH-NAME> -> ssh directly to instance
```

### Start a stopped workspace
Expand All @@ -245,10 +245,10 @@ You have 1 workspace in Org brev.dev
NAME STATUS URL ID
linear-client STOPPED linear-client-yw1a-brevdev.wgt-us-west-2-test.brev.dev gov5jyw1a

Connect to running workspace:
brev open linear-client # brev open <NAME> -> open workspace in preferred editor
brev shell linear-client # brev shell <NAME> -> ssh into workspace (shortcut)
ssh linear-client-yw1a # ssh <SSH-NAME> -> ssh directly to workspace
Connect to running instance:
brev open linear-client # brev open <NAME> -> open instance in preferred editor
brev shell linear-client # brev shell <NAME> -> ssh into instance (shortcut)
ssh linear-client-yw1a # ssh <SSH-NAME> -> ssh directly to instance

```

Expand Down
Loading