@inbox-zero/cli

CLI tool for running Inbox Zero - an open-source AI email assistant.

Installation

Homebrew (macOS/Linux)

brew install inbox-zero/inbox-zero/inbox-zero

Manual Installation

Download the binary for your platform from releases and add to your PATH.

Quick Start

# Configure Inbox Zero (interactive)
inbox-zero setup

# Start Inbox Zero
inbox-zero start

# Open http://localhost:3000

Commands

inbox-zero setup

Interactive setup wizard that:

• Configures OAuth providers (Google/Microsoft)
• Sets up your LLM provider and API key
• Configures ports (to avoid conflicts)
• Generates all required secrets

Configuration is stored in ~/.inbox-zero/

inbox-zero setup-terraform

Generates Terraform files for AWS deployment (ECS Fargate, RDS, optional Redis).

# Generate Terraform files in ./terraform (interactive)
inbox-zero setup-terraform

# Non-interactive mode (values read from flags/env vars)
inbox-zero setup-terraform --yes --region us-east-1

The generated Terraform uses AWS SSM Parameter Store for secrets and outputs the service URL after terraform apply.

inbox-zero start

Pulls the latest Docker image and starts all containers:

• PostgreSQL database
• Redis cache
• Inbox Zero web app
• Cron job for email sync

inbox-zero start           # Start in background
inbox-zero start --no-detach  # Start in foreground

inbox-zero stop

Stops all running containers.

inbox-zero stop

inbox-zero logs

View container logs.

inbox-zero logs            # Show last 100 lines
inbox-zero logs -f         # Follow logs
inbox-zero logs -n 500     # Show last 500 lines

inbox-zero status

Show status of running containers.

inbox-zero update

Pull the latest Inbox Zero image and optionally restart.

inbox-zero update

Requirements

• Docker Desktop installed and running
• OAuth credentials from Google and/or Microsoft
• An LLM API key (Anthropic, OpenAI, Google, etc.)

Configuration

All configuration is stored in ~/.inbox-zero/:

• .env - Environment variables
• docker-compose.yml - Docker Compose configuration

To reconfigure, run inbox-zero setup again.

License

See LICENSE in the repository root.