gmcli v1.0A

Immutable. This exact content never changes and is served at /api/v1/blob/b3f06fd274bbc404.

---
name: gmcli
description: "Gmail CLI for searching emails, reading threads, sending messages, managing drafts, and handling labels/attachments. Triggers: Gmail, send email, search email, read email, email thread, email draft, email labels, gmcli."
compatibility: Requires Google OAuth credentials configured via gmcli setup
allowed-tools: Bash(gmcli:*)
metadata:
  version: "1.0"
  author: canvas-studios
---

# Gmail CLI

Command-line interface for Gmail operations.

## Installation

In Canvas Notebook Docker, a container admin installs this once:
```bash
npm install -g @mariozechner/gmcli
```

Check if installed:
```bash
gmcli --help
```

## Setup

### Google Cloud Console (one-time)

1. [Create a new project](https://console.cloud.google.com/projectcreate) (or select existing)
2. [Enable the Gmail API](https://console.cloud.google.com/apis/api/gmail.googleapis.com)
3. [Set app name](https://console.cloud.google.com/auth/branding) in OAuth branding
4. [Add test users](https://console.cloud.google.com/auth/audience) (all Gmail addresses you want to use)
5. [Create OAuth client](https://console.cloud.google.com/auth/clients):
   - Click "Create Client"
   - Application type: "Desktop app"
   - Download the JSON file

### Configure gmcli

First check if already configured:
```bash
gmcli accounts list
```

If no accounts, guide the user through setup:
1. Ask if they have a Google Cloud project with Gmail API enabled
2. If not, walk them through the Google Cloud Console steps above
3. Have them download the OAuth credentials JSON
4. Run: `gmcli accounts credentials ~/path/to/credentials.json`
5. Run: `gmcli accounts add <email>` (use `--manual` for browserless OAuth)

## Usage

Run `gmcli --help` for full command reference.

Common operations:
- `gmcli <email> search "<query>"` - Search emails using Gmail query syntax
- `gmcli <email> thread <threadId>` - Read a thread with all messages
- `gmcli <email> send --to <emails> --subject <s> --body <b>` - Send email
- `gmcli <email> labels list` - List all labels
- `gmcli <email> drafts list` - List drafts

## Data Storage

- `~/.gmcli/credentials.json` - OAuth client credentials
- `~/.gmcli/accounts.json` - Account tokens
- `~/.gmcli/attachments/` - Downloaded attachments