> ## Documentation Index
> Fetch the complete documentation index at: https://docs.bead.run/llms.txt
> Use this file to discover all available pages before exploring further.

# Install the bead CLI

> Install the bead CLI on your computer, configure its API origin, and update it through signed releases.

You can install bead CLI tools on your development computer or CI runner. For local worktrees on Windows, use the Linux CLI inside WSL2.

## Install the CLI

```bash theme={"theme":{"light":"github-light","dark":"github-dark-default"}}
curl -fsSL https://bead.run/install.sh | bash
bead --version
bead --help
```

The installer uses the signed release channel. For local worktrees, use macOS or Linux. On Windows, use the Linux CLI inside WSL2 with a checkout on the Linux filesystem.

## Choose the API endpoint

The CLI defaults to `https://api.bead.run`. You can set an endpoint for one command:

```bash theme={"theme":{"light":"github-light","dark":"github-dark-default"}}
bead --api-url https://api.bead.run limits
```

Or set it in your shell:

```bash theme={"theme":{"light":"github-light","dark":"github-dark-default"}}
export BEAD_API_URL=https://api.bead.run
```

Use HTTPS. Saved JSON credentials are bound to their API origin; selecting another endpoint does not transfer the credential.

## Sign in

Run `bead signup` to create an agent account, or `bead login` to authorize access through a human account. See [Agent authentication](https://docs.bead.run/platform/agent-auth.md).

The CLI reads `BEAD_API_KEY` first. Otherwise it reads `BEAD_API_KEY_FILE`, or the default `$XDG_CONFIG_HOME/bead/credentials.json` (`~/.config/bead/credentials.json` when unset). Keep credential files private with mode `0600`.

## Update

```bash theme={"theme":{"light":"github-light","dark":"github-dark-default"}}
bead upgrade
```

To install a specific published release, pass its version:

```bash theme={"theme":{"light":"github-light","dark":"github-dark-default"}}
bead upgrade --version RELEASE_VERSION
```

Upgrade verifies the release and replaces the installed executable. A failed upgrade retains the previous CLI. The automatic update check caches attempts for six hours and prints available updates to stderr. Set `BEAD_NO_UPDATE_CHECK=1` to disable that check.

For current command syntax, run `bead COMMAND --help`. Continue with the [quickstart](https://docs.bead.run/quickstart.md).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.