Skip to content

chore(BRE2-867): update readme #336

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

Merged
patelspratik merged 1 commit into from
Mar 16, 2026
Merged

chore(BRE2-867): update readme #336

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
39 changes: 22 additions & 17 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,26 +4,17 @@

## Install the cli

### From conda-forge

To globally install `brev` [from conda-forge](https://github.com/conda-forge/brev-feedstock/) in an isolated environment with [`Pixi`](https://pixi.sh/), run

```
pixi global install brev
```

### MacOS
Assumes [Homebrew](https://brew.sh/) (or Workbrew equivalent) are installed.

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

### Linux

```bash
sudo bash -c "$(curl -fsSL https://raw.githubusercontent.com/brevdev/brev-cli/main/bin/install-latest.sh)"
brev login
```

### Windows
Expand All @@ -34,33 +25,47 @@ Brev is supported on windows currently through the Windows Subsystem for Linux (
**Prerequisites**
- WSL installed and configured
- Virtualization enabled in your BIOS
- Ubuntu 20.04 installed from the Microsoft Store
- Ubuntu >=22.04 installed from the Microsoft Store

Once you have WSL installed and configured, you can install Brev by running the following command in your terminal:

```bash
sudo bash -c "$(curl -fsSL https://raw.githubusercontent.com/brevdev/brev-cli/main/bin/install-latest.sh)"
```
**Next Steps**

### From conda-forge

To globally install `brev` [from conda-forge](https://github.com/conda-forge/brev-feedstock/) in an isolated environment with [`Pixi`](https://pixi.sh/), run

```
pixi global install brev
```
## Get Started

Log in to your Brev account:

```bash
```bash
brev login
```

## Get Started
Create a new GPU instance:

https://brev.nvidia.com/
```bash
brev create awesome-gpu-name
```

See the instance:

```bash
brev ls
```

## Docs

https://docs.nvidia.com/brev/latest/

---

https://user-images.githubusercontent.com/14320477/170176621-6b871798-baef-4d42-affe-063a76eca9da.mp4

## AI Agent Integration

Brev CLI includes a skill for AI coding agents (like [Claude Code](https://claude.com/claude-code)) that enables natural language GPU instance management.
Expand Down
Loading