Command

nylas init

The nylas init command walks you through setting up the Nylas CLI in four steps: creating or logging into your Nylas account, selecting or creating an application, generating an API key, and syncing your connected email accounts. If you already have an API key, pass --api-key to skip the interactive wizard. Works with Gmail, Outlook, Exchange, Yahoo, iCloud, and IMAP.

Written by Qasim Muhammad Staff SRE

What does nylas init do?

The nylas init command walks you through setting up the Nylas CLI in four steps: creating or logging into your Nylas account, selecting or creating an application, generating an API key, and syncing your connected email accounts. If you already have an API key, pass --api-key to skip the interactive wizard. Works with Gmail, Outlook, Exchange, Yahoo, iCloud, and IMAP.

Usage

nylas init [--api-key KEY] [--region us|eu] [--google|--microsoft|--github]

Flags

FlagDescription
--jsonOutput as JSON
--no-colorDisable color output
--verbose(-v)Enable verbose output
--configCustom config file path
--help(-h)Show help for the command
--limitLimit results (most list commands)
--yes(-y)Skip confirmations
--api-keyNylas API key (skips interactive wizard)
--region(-r)API region: us or eu (default: us)
--googleUse Google SSO for account creation/login
--microsoftUse Microsoft SSO for account creation/login
--githubUse GitHub SSO for account creation/login

Examples

Interactive guided setup

nylas init
# Follow the 4-step wizard:
#   Step 1: Create account or log in
#   Step 2: Select or create application
#   Step 3: Generate API key
#   Step 4: Sync email accounts

Quick setup with existing API key

nylas init --api-key nyl_abc123

Quick setup for EU region

nylas init --api-key nyl_abc123 --region eu

Start with Google SSO

nylas init --google

Troubleshooting

Wizard fails with 'non-interactive mode requires --api-key'

The wizard needs a terminal (TTY). In CI/CD or scripts, pass --api-key directly.

SSO browser window doesn't open

Copy the URL printed in the terminal and open it manually in your browser.

API key verification fails

Check the key at dashboard-v3.nylas.com. Ensure no extra whitespace when pasting.

Recommended guides

Automate Customer Onboarding Emails

Run a multi-day onboarding sequence from a signup hook with nylas email send --schedule and hosted templates — no marketing platform, no SMTP.

Getting Started with Agent Accounts

How Nylas Agent Account works. Architecture from Application to Workspace, inbound and outbound email flows, and why managed email replaces SMTP for AI agents.

Set Up an MCP Email Server in 5 Minutes

Connect AI agents to real email accounts through MCP. Install, configure, and verify an email MCP server for Claude Code, Cursor, and other AI coding tools.

Install Nylas Skills for AI Coding Agents

Install nylas-cli and nylas-api skills in Claude Code, Cursor, Codex CLI, Windsurf, and 30+ AI coding agents. One command adds email and calendar tools.

Getting Started with the CLI

Set up Nylas CLI in under 2 minutes. Create a free Nylas account, get an API key from the dashboard, and run nylas auth config. No browser auth flow needed.

Give Your AI Coding Agent an Email Address

Connect Claude Code, Cursor, OpenAI Codex CLI, Windsurf, and OpenClaw to a real email account via MCP. Step-by-step setup for each tool using Nylas CLI.

Install OpenClaw CLI for the Nylas Plugin

Install OpenClaw CLI to run the Nylas email and calendar plugin. Covers Node.js version, npm install, PATH configuration, Windows steps, and validation.

Automate Email with Manus AI: Beginner Guide

Five-minute quickstart for Manus + Nylas CLI. Install the Skill, authenticate one mailbox, send a test email, list recent mail, and run your first search.

Install the OpenClaw Nylas Plugin

Install @nylas/openclaw-nylas-plugin to add native email, calendar, and contact tools to OpenClaw. Covers API key setup, grant discovery, and plugin vs exec.

Run nylas init --help for full help output.