Command

nylas auth migrate

Migrate from v2 to v3.

Written by Qasim Muhammad Staff SRE

Published February 13, 2026Updated June 21, 2026

What does nylas auth migrate do?

The nylas auth migrate command upgrades your CLI authentication from Nylas API v2 to v3. It converts stored credentials and grant formats so existing scripts and automation continue working after the migration.

Usage

nylas auth migrate

Flags

Flag	Description
--json	Output as JSON
--no-color	Disable color output
--verbose(-v)	Enable verbose output
--config	Custom config file path
--help(-h)	Show help for the command
--limit	Limit results (most list commands)
--yes(-y)	Skip confirmations

Examples

The nylas auth migrate command upgrades your CLI authentication from Nylas API v2 to v3.

Run migration

nylas auth migrate

Check migration status after

nylas auth migrate && nylas auth status

Example output

Migrating credentials from encrypted file to system keyring...

✓ API key migrated
✓ 3 grants migrated
✓ Encrypted file store removed

Credentials now stored in macOS Keychain

Troubleshooting

No v2 credentials found

This means you're already on v3, or no accounts were connected under v2. No action needed.

Migration fails with permission error

Check that your API key has v3 access. Contact Nylas support if your account hasn't been upgraded.

Recommended guides

List Fastmail emails from the CLI

List Fastmail emails from the CLI through Nylas IMAP access, using app passwords, inbox filters, JSON output, and Fastmail-specific auth troubleshooting.

Book meeting rooms from the CLI

Book meeting rooms from the CLI by listing calendar resources, using each room email as a calendar ID, and adding it as an event participant with less setup.

OfflineIMAP vs Nylas: Python IMAP sync

OfflineIMAP is a Python tool that syncs IMAP mail to local Maildir. Compare its config, Gmail OAuth2, sync speed, and an API email CLI that skips the mirror.

neomutt vs Nylas: IMAP reader vs email API

neomutt is a configurable IMAP terminal mail reader. Compare it to an API-backed email CLI on OAuth setup, scripting, offline access, and calendar reach.

mbsync vs Nylas: IMAP sync vs email API

mbsync (isync) syncs IMAP mailboxes to local Maildir for mutt or neomutt. Compare its sync model, Gmail OAuth setup, and where an API email CLI skips it.

Google Calendar API Sync Tokens

Use Google Calendar API sync tokens for incremental event sync, handle the 410 GONE full-resync, and read calendars from the CLI.

Run nylas auth migrate --help for full help output.