debug
🎯Skillfrom elie222/inbox-zero
I apologize, but I cannot confidently infer the specific functionality of a "debug" Claude Code skill from the provided README. The README describes an AI email assistant project, but does not ment...
Installation
git clone https://github.com/elie222/inbox-zero.gitdocker compose --profile all downdocker compose -f docker-compose.dev.yml up -dpnpm installpnpm devSkill Details
Overview
[](https://www.getinboxzero.com)
Inbox Zero - your 24/7 AI email assistant
Organizes your inbox, pre-drafts replies, and tracks follow‑ups - so you reach inbox zero faster. Open source alternative to Fyxer, but more customisable and secure.
·
·
  [](https://vercel.com/oss)
Mission
To help you spend less time in your inbox, so you can focus on what matters most.
[](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Felie222%2Finbox-zero&env=AUTH_SECRET,GOOGLE_CLIENT_ID,GOOGLE_CLIENT_SECRET,MICROSOFT_CLIENT_ID,MICROSOFT_CLIENT_SECRET,EMAIL_ENCRYPT_SECRET,EMAIL_ENCRYPT_SALT,UPSTASH_REDIS_URL,UPSTASH_REDIS_TOKEN,GOOGLE_PUBSUB_TOPIC_NAME,DATABASE_URL,NEXT_PUBLIC_BASE_URL)
Features
- AI Personal Assistant: Organizes your inbox and pre-drafts replies in your tone and style.
- Cursor Rules for email: Explain in plain English how your AI should handle your inbox.
- Reply Zero: Track emails to reply to and those awaiting responses.
- Smart Categories: Automatically categorize every sender.
- Bulk Unsubscriber: One-click unsubscribe and archive emails you never read.
- Cold Email Blocker: Auto‑block cold emails.
- Email Analytics: Track your activity and trends over time.
- Meeting Briefs (Beta): Get personalized briefings before every meeting, pulling context from your email and calendar.
- Smart Filing (Early Access): Automatically save email attachments to Google Drive or OneDrive.
Learn more in our [docs](https://docs.getinboxzero.com).
Feature Screenshots
|  |  |
| :------------------------------------------------------: | :-------------------------------------------------------------: |
| _AI Assistant_ | _Reply Zero_ |
|  |  |
| _Gmail client_ | _Bulk Unsubscriber_ |
Demo Video
[](http://www.youtube.com/watch?v=hfvKvTHBjG0)
Built with
- [Next.js](https://nextjs.org/)
- [Tailwind CSS](https://tailwindcss.com/)
- [shadcn/ui](https://ui.shadcn.com/)
- [Prisma](https://www.prisma.io/)
- [Upstash](https://upstash.com/)
- [Turborepo](https://turbo.build/)
- [Popsy Illustrations](https://popsy.co/)
Star History
[](https://www.star-history.com/#elie222/inbox-zero&Date)
Feature Requests
To request a feature open a [GitHub issue](https://github.com/elie222/inbox-zero/issues), or join our [Discord](https://www.getinboxzero.com/discord).
Getting Started
We offer a hosted version of Inbox Zero at [https://getinboxzero.com](https://www.getinboxzero.com).
Self-Hosting
The easiest way to self-host Inbox Zero is using our pre-built Docker image.
> Prerequisites: [Docker Desktop](https://www.docker.com/products/docker-desktop/), [Node.js](https://nodejs.org/) v22+, and [Git](https://git-scm.com/downloads)
```bash
git clone https://github.com/elie222/inbox-zero.git
cd inbox-zero
npm install
npm run setup
# Start Docker (Linux/Mac)
NEXT_PUBLIC_BASE_URL=http://localhost:3000 docker compose --profile all up -d
# Start Docker (Windows PowerShell)
# $env:NEXT_PUBLIC_BASE_URL="http://localhost:3000"; docker compose --profile all up -d
# Verify startup (wait for "Ready" message, Ctrl+C to exit logs)
docker logs inbox-zero-services-web-1 -f
```
Open http://localhost:3000
> Tip: The setup CLI guides you through configuring your AI provider (OpenAI, Anthropic, etc.) and connecting Google or Microsoft accounts. For the fastest setup, choose the defaults and select "Full Docker Compose" when asked about databases. See [Google OAuth Setup](#google-oauth-setup) and [Microsoft OAuth Setup](#microsoft-oauth-setup) below for detailed configuration instructions.
>
> Important: You must enable the [Gmail API](https://console.cloud.google.com/apis/library/gmail.googleapis.com) and [Google People API](https://console.cloud.google.com/apis/library/people.googleapis.com) in your Google Cloud project, or sign-in will fail.
To update your configuration or pull the latest version:
```bash
docker compose --profile all down
NEXT_PUBLIC_BASE_URL=http://localhost:3000 docker compose --profile all up -d
```
See our [Self-Hosting Guide](docs/hosting/self-hosting.md) for complete instructions, production deployment, and configuration options.
Local Development Setup
[Here's a video](https://youtu.be/hVQENQ4WT2Y) on how to set up the project. It covers the same steps mentioned in this document. But goes into greater detail on setting up the external services.
#### Option A: Devcontainer
The fastest way to get started is using [devcontainers](https://containers.dev/), supported by VS Code ([Dev Containers extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers)), JetBrains IDEs, and other modern editors:
- Open the project and select "Reopen in Container" when prompted
- Wait for container to build and
postCreateCommandto complete - Configure at least one OAuth provider in
apps/web/.env(see [Google OAuth Setup](#google-oauth-setup) or [Microsoft OAuth Setup](#microsoft-oauth-setup) below for credentials and redirect URIs) - Run
pnpm dev
#### Option B: Manual Setup
#### Requirements
- [Node.js](https://nodejs.org/en/) >= 22.0.0
- [pnpm](https://pnpm.io/) >= 10.0.0
- [Docker desktop](https://www.docker.com/products/docker-desktop/) (recommended for running Postgres and Redis)
#### Quick Start
- Start PostgreSQL and Redis:
```bash
docker compose -f docker-compose.dev.yml up -d
```
- Install dependencies and set up environment:
```bash
pnpm install
```
Option A: Interactive CLI - Guides you through each step and auto-generates secrets
```bash
npm run setup
```
Option B: Manual setup - Copy the example file and edit it yourself
```bash
cp apps/web/.env.example apps/web/.env
# Generate secrets with: openssl rand -hex 32
```
- Run database migrations:
```bash
cd apps/web
pnpm prisma migrate dev
```
- Run the development server:
```bash
pnpm dev
```
The app will be available at http://localhost:3000.
The sections below provide detailed setup instructions for OAuth and other services. For a comprehensive reference of all environment variables, see the [Environment Variables Guide](docs/hosting/environment-variables.md).
Google OAuth Setup
> Quick Setup with CLI: If you have the gcloud CLI installed, you can use inbox-zero setup-google to automate API enabling and Pub/Sub setup. It will guide y