Brev CLI Reference Docs

The Brev CLI wraps SSH to quickly get you in your instance, while also letting you do almost everything you can do from the console from the command line.

Every command has a --help flag if you need to see options.

Brev CLI commands are broken up into 4 categories:

Workspace commands
Context commands
SSH command
Housekeeping commands.

Installation Instructions

Install the Brev CLI to easily jump in and out of your instances, scale hardware and manage your org:

brew install brevdev/homebrew-brev/brev && brev login

If you had trouble installing let us know in our Discord!

Workspace Commands

scale

Scale an instance up or down

Synopsis

    brev scale [ Workspace Name or ID... ] --gpu [GPU Instance]

#	or

	brev scale [ Workspace Name or ID... ] --cpu [CPU Instance]

Description

Move your instance to a different size machine. All work, settings, etc will be persisted. View available instance types here.

Examples

Scale to a GPU instance

$ brev scale brev-environments-ui --gpu g5g.xlarge

Scale to a CPU instance

$ brev scale brev-environments-ui --cpu 2x8

delete

Delete a Workspace by name or ID.

Synopsis

    brev delete [ Workspace Name or ID... ]

Description

Deleting a workspace will permanently delete a workspace from your account. This command will delete all content in the workspace and any volumes associated with the workspace. This command is not reversable and can result in lost work.

Examples

Delete a workspace

$ brev delete payments-frontend
Deleting workspace payments-frontend. This can take a few minutes. Run 'brev ls' to check status

Delete multiple workspaces

$ brev delete bar euler54 naive-pubsub jupyter
Deleting workspace bar. This can take a few minutes. Run 'brev ls' to check status
Deleting workspace euler54. This can take a few minutes. Run 'brev ls' to check status
Deleting workspace naive-pubsub. This can take a few minutes. Run 'brev ls' to check status
Deleting workspace jupyter. This can take a few minutes. Run 'brev ls' to check status

reset

Description

This command deletes your machine and gets you a fresh one. Make sure to have a .brev setup script or you'll have to reinstall everythign manually.

Note: even if not committed, the .brev/setup.sh script will persist because everythign in /home/workspace will be saved. 👆 This makes it really easy to change your environment without needing to commit the changes to main.

Example

reset a workspace with the name payments-frontend

$ brev reset payments-frontend
Workspace payments-frontend is resetting.
Note: this can take a few seconds. Run 'brev ls' to check status

start

create start and join a workspace

Synopsis


brev start { ARG | -e} {-n | --name} {-c | --class} { -s | --setup-script}
	{-r | --setup-repo} {-p | --setup-path } { -o | --org}

Description

brev start can do the following:

start a stopped workspace
join a workspace in an organization
create an empty workspace
create a workspace from a directory on your computer
create a workspace from a git url

Flags

-n --name <name>

specify the name for your workspace instead of brev-cli generating one for you.

for example, to override the name of a workspace when creating a workspace from a git repo you could do it with then -n flag. This example creates a repo with the name cli from the git repo https://github.com/brevdev/brev-cli.

$ brev start https://github.com/brevdev/brev-cli -n cli