@inbox-zero/cli

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

Installation

$3

``bash
brew install inbox-zero/inbox-zero/inbox-zero
`

$3

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

Quick Start

`bash


Configure Inbox Zero (interactive)

inbox-zero setup

Start Inbox Zero

inbox-zero start

Open http://localhost:3000

`

Commands

$3

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/

$3

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

`bash


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.

$3

Pulls the latest Docker image and starts all containers:
- PostgreSQL database
- Redis cache
- Inbox Zero web app
- Cron job for email sync

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

$3

Stops all running containers.

`bash
inbox-zero stop
`

$3

View container logs.

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

$3

Show status of running containers.

$3

Pull the latest Inbox Zero image and optionally restart.

`bash
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.