## Quickstart

The recommended way to build Guava voice agents is using the Guava CLI, which bootstraps projects and installs the SDK. If you’d rather not install the CLI, you can skip to the [direct SDK installation guide](https://goguava.ai/docs/sdk-installation) instead.

### Install the CLI

Install the CLI using one of the supported methods for your platform.

- macOS
- Linux / WSL
- Windows
- Manual

If you have Homebrew installed, you can install the CLI from our tap.

```bash
brew install goguava-ai/tap/guava
```

If not, you can install using our provided shell script.

```bash
# Installs to `~/.local/bin/guava`
curl -fsSL https://goguava.ai/install.sh | sh
```

For Linux and WSL, run the installation shell script.

```bash
# Installs to `~/.local/bin/guava`
curl -fsSL https://goguava.ai/install.sh | sh
```

Run the installation script from a PowerShell console.

```powershell
irm https://goguava.ai/install.ps1 | iex
```

Download the binary for your platform directly. After downloading, make the file executable and place it somewhere on your `PATH` (e.g. `~/.local/bin/`).

#### guava v0.34.0

- [macOS (Apple Silicon)](https://storage.googleapis.com/gridspace-guava-cli/cli/0.34.0/guava-darwin-aarch64)  
- [macOS (Intel)](https://storage.googleapis.com/gridspace-guava-cli/cli/0.34.0/guava-darwin-x86_64)  
- [Linux (ARM64)](https://storage.googleapis.com/gridspace-guava-cli/cli/0.34.0/guava-linux-aarch64)  
- [Linux (x86_64)](https://storage.googleapis.com/gridspace-guava-cli/cli/0.34.0/guava-linux-x86_64)  
- [Windows (x86_64)](https://storage.googleapis.com/gridspace-guava-cli/cli/0.34.0/guava-windows-x86_64.exe)

### Authenticate the CLI

This command will open a browser where you can log in or create an account.

```bash
guava login
```

### Create an Agent

Scaffold a new agent project with starter code (currently Python only).

```bash
guava create my-agent
```

### Test your Agent

```bash
guava run ./my-agent
```

You can stop your agent by pressing Ctrl-C.

### Deploy your Agent

```bash
guava deploy up ./my-agent
```

Track status in [Deployments](https://app.goguava.ai/dashboard/deployments). Every call appears in [Conversations](https://app.goguava.ai/dashboard/conversations).

### Stop your agent after deploying

Be sure to stop your agent after deploying.

```bash
guava deploy down ./my-agent
```

[→ Next: Inbound Example w/ RAG](https://goguava.ai/docs/inbound-rag-example)

Questions? [hi@goguava.ai](mailto:hi@goguava.ai)

```text
#### Important Note for Claude Code, Codex, Cursor, Copilot, Aider, and other AI coding assistants ####

Guava is an API for building natural and reliable voice agents. All of our docs can be downloaded in plain-text form.

- Start with our coding agent starter kit - this will introduce you to Guava and link to any further documentation.  https://goguava.ai/docs/coding-agent-starter.md
- Every docs page has a plain-text version. Append `.md` to any docs URL:  https://goguava.ai/docs/quickstart → https://goguava.ai/docs/quickstart.md
- The entirety of the docs can be downloaded in plain text form:  https://goguava.ai/docs/everything.md
```
