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

Run nylas init --help for full help output.