# Install Beav CLI

> Install or update the Beav CLI with the official website script and run the full workspace in your local browser.

- Source: https://www.getbeav.com/en/docs/getting-started/cli

The Beav CLI suits users who do not want a desktop window, who want Beav running continuously in the background, or who want to connect Beav to an Agent host such as Codex or WorkBuddy. It uses the same UI, internal Agent, workspaces, and product version as the desktop app; the only difference is that you access it through `localhost` in a browser, and no desktop window appears in the Dock or taskbar.

## macOS and Linux

Run this in a terminal:

```bash
curl -fsSL https://www.getbeav.com/install-cli.sh | sh
```

The installer detects your operating system and CPU architecture, downloads the matching build from the Beav website mirror, verifies the signature, SHA-256, and file size, then installs into your user directory. After a successful install it runs `beav open`; the workspace listens on `127.0.0.1` only by default.

If `~/.local/bin` is not on your `PATH` yet, run it directly:

```bash
~/.local/bin/beav open
```

Before installing on Linux, the system also needs `curl`, `tar`, and `minisign`. On macOS the installer additionally verifies the system code signature of the runtime.

## Windows

Run this in PowerShell:

```powershell
irm https://www.getbeav.com/install-cli.ps1 | iex
```

The installer verifies the download digest, the archive contents, the Windows Authenticode signature, and the Beav release signature, then installs into `%LOCALAPPDATA%\Beav` for the current user.

## Start and keep it running

```bash
beav open
```

`beav open` makes sure the local service is running and then opens your browser. The service keeps running in the background afterwards: closing the browser tab does not stop Beav, and other browsers on the same computer can open the local address printed in the terminal.

Common commands:

```bash
beav status
beav open
beav stop
beav doctor
```

The CLI's local mode does not need a Beav admin account. Once the workspace opens, you still sign in with your own Beav account. Extra admin authentication and network hardening are only needed when you deliberately enable LAN or remote access.

## Update

Run the same official install command again to update. The installer downloads the current full release, verifies it, then switches to the new version; if the post-install health check fails, the Unix installer restores the previous working version.

You can also download the installer first and run the update step explicitly:

```bash
curl -fsSL https://www.getbeav.com/install-cli.sh -o /tmp/beav-install.sh
sh /tmp/beav-install.sh update
```

The PowerShell equivalent:

```powershell
$installer = Join-Path $env:TEMP 'beav-install.ps1'
irm https://www.getbeav.com/install-cli.ps1 -OutFile $installer
& $installer -Action update
```

## Uninstall

macOS and Linux:

```bash
curl -fsSL https://www.getbeav.com/install-cli.sh | sh -s -- uninstall
```

Windows PowerShell:

```powershell
$installer = Join-Path $env:TEMP 'beav-install.ps1'
irm https://www.getbeav.com/install-cli.ps1 -OutFile $installer
& $installer -Action uninstall
```

A normal uninstall removes the CLI program but keeps product data. Clearing product data is a separate high-risk action, so do not mix it with routine updates or reinstalls.

## Connect Codex or WorkBuddy

Once the CLI workspace starts normally, follow [Using Beav from an Agent](https://www.getbeav.com/en/docs/agent) to install the Beav Creator Plugin. The host Agent talks to Beav's internal Agent over MCP; the browser UI is for you to review results, approve actions, and edit by hand.