Documentation | Guava

CLI Reference

guava is the primary interface for working with Guava. It handles authentication, project scaffolding, local runs, deployment, phone number provisioning, conversation history, org management, outbound campaigns, and WebRTC widget codes. The Guava SDK is installed automatically as part of the project template.

Quick reference

Command reference

guava login

Authenticates the CLI against Guava via OAuth. Opens your default browser to a sign-in page and stores the resulting credentials locally so subsequent commands can call the API on your behalf.

guava logout

Clears stored credentials. No parameters.

guava create

Scaffolds a new Guava project on disk — generates main.py, pyproject.toml, PRD.md, README.md, and the guava.toml config — and (unless --skip-deps is set) runs uv sync to install dependencies. For outbound projects it also creates the matching campaign on the server.

guava create runs in interactive mode by default — the CLI prompts for anything you don't pass. In non-interactive mode (when stdin is not a TTY, or when you pass --no-prompt), there are no prompts: required flags must be supplied or the command errors, and optional flags fall back to documented defaults.

Positional argument

Non-interactive mode flags — in interactive mode you can omit any of these and the CLI will prompt; in non-interactive mode they behave as noted under "Required".

Inbound-only (--direction inbound):

Outbound-only (--direction outbound):

Passing an inbound-only flag with --direction outbound (or vice-versa) will result in an error.

guava run

Runs the agent locally on your machine. Anything after -- is forwarded straight to main.py, which is useful for one-off flags your agent reads from argv.

guava update

Edits the fields in guava.toml — project name, base image, and instance tier — without re-scaffolding the project. Use this whenever you want to bump the Python sandbox version or move between tiers.

Like create, guava update runs in interactive mode by default and prompts for each field, showing the current value as the default. In non-interactive mode (--no-prompt or no TTY), no prompts run and any field you don't pass simply keeps its current value — nothing is required.

Non-interactive mode flags — in interactive mode the CLI prompts for each of these; in non-interactive mode, any flag you omit leaves the existing value unchanged.

guava self-upgrade

Updates the guava binary itself to the latest released version. No parameters.

guava deploy up

guava deploy down

guava deploy scale

Scales an already-running deployment up or down by setting the desired pod-replica count. Use this to handle traffic spikes or scale back when idle without redeploying.

guava deploy status

guava deploy logs

guava deploy build-logs

guava deploy list

Lists all deployments for the authenticated user as a table (NAME, NUMBER, ACTIVE, ID). ls is an alias for list.

guava deploy changed

Checks whether project files have changed since the last deploy.

guava numbers list

Lists every phone number your active org owns. ls is an alias for list. No parameters.

guava numbers buy

Purchases a phone number and stores it in guava.toml. On the next deploy, the number is available to your code via the GUAVA_AGENT_NUMBER environment variable.

guava conversations list

Lists past conversations (calls) for your active org, newest first. All filters are optional and can be combined; results are paginated via --after.

guava conversations get | transcript | recording

Inspect a single past call by ID — get returns the metadata and outcome, transcript returns the speaker-by-speaker text, and recording downloads the raw audio.

All take a positional call_id. recording also accepts -o, --output <path> (default <call_id>.wav).

guava org

Lists the orgs you belong to and lets you switch which one the CLI acts on. The active org determines which numbers, deployments, conversations, and campaigns the other commands see.

guava campaigns

Manage outbound campaigns from the CLI: inspect their state, pause/resume/delete them, and upload contact lists. Each campaign is referenced by its code, a gcmp--prefixed identifier (e.g. gcmp-xxxxxxxxxxxxxxxxxxxx) shown by guava campaigns list or on the dashboard.

add-contacts arguments

Every contact must include a phone_number field in E.164 format (e.g. +15555550100).

guava widget

Mints a short code that lets a browser-based WebRTC widget connect to your deployed agent. Use --ttl for a code that auto-expires; omit it for one that stays valid indefinitely.

The guava.toml file

Every Guava project has a guava.toml file in its root directory, created by guava create or guava deploy up. It stores the project's configuration and deployment state. The CLI reads it to identify the project and track deployments.

Projects created with CLI versions 0.29.0 and lower will have a JSON .guava file. The CLI will automatically migrate to the new guava.toml on the next save.

Do not edit this file manually. Use guava update to change settings. Manually editing guava.toml can put your project into an inconsistent state and cause deploy failures.

Commit this file to git. If you delete it or leave it out of version control, the CLI won't be able to find your project or resume previous deployments.

guava.toml

project_id = "auto-generated unique ID"
name = "your project name"
base_image = "python-sandbox:3.14"
tier = "guava-seed"           # guava-seed | guava-fruit | guava-tree
replicas = 1
phone_number = "+15555555555"  # set by guava numbers buy or guava create --phone
call_direction = "inbound"     # inbound | outbound
org_id = "..."

Instance tiers

Base images & dependencies

When you create a project, you choose a base image. During deployment, your code and dependencies are built on top of this image to produce the final container that runs in the cloud. You can change the base image later with guava update.

Available base images:

• python-sandbox:3.14
• python-sandbox:3.13
• python-sandbox:3.12
• python-sandbox:3.11
• python-sandbox:3.10

Dependencies are installed from pyproject.toml, requirements.txt, uv.lock, or poetry.lock.

Troubleshooting

• "Please run guava login" — Your session has expired or you haven't logged in yet. Run guava login to re-authenticate.
• "No main.py found" — deploy up requires a main.py in your project directory. Make sure you're running the command from the right folder.
• Deploy didn't pick up my changes — If nothing changed since the last deploy, the build step is skipped automatically. Use guava deploy up --rebuild to force a full rebuild.
• Build failed — Run guava deploy build-logs to see the full build output and diagnose the issue.
• Missing files in deployment — deploy up excludes guava.toml, hidden files/dirs, __pycache__, and node_modules from the upload. Make sure your files aren't in an excluded path.
• Dependencies not installing — The build system auto-detects dependencies from pyproject.toml, requirements.txt, uv.lock, or poetry.lock. Make sure one of these is present in your project root.

Example

# Log in (opens browser)
guava login

# Create a new project
guava create my-agent --direction inbound

# Run locally
cd my-agent
guava run

# Deploy the project
guava deploy up

# Scale to 3 replicas
guava deploy scale 3

# View runtime logs
guava deploy logs -n 50

# Browse recent conversations
guava conversations list --direction inbound -n 20

# Download a call recording
guava conversations recording <call_id> -o call.wav

# Tear down
guava deploy down