Command
nylas auth login
Authenticate with a provider (Gmail, Outlook, etc.) to connect your mailbox.
Written by Qasim Muhammad Staff SRE
What does nylas auth login do?
The nylas auth login command connects your email account to the CLI via OAuth. It opens a browser window, walks you through the provider's consent flow, and stores the grant locally. Supports Gmail, Outlook, Exchange, Yahoo, iCloud, and IMAP providers. Once authenticated, all email, calendar, and contact commands work against that account.
Usage
nylas auth loginFlags
| 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 |
| --provider(-p) | Email provider (google, microsoft, ews, icloud, yahoo, imap) |
Examples
The nylas auth login command connects your email account to the CLI via OAuth.
Connect Gmail or Outlook
nylas auth login
# Opens browser for OAuth; follow prompts to connectExample output
Opening browser for Google OAuth...
→ https://accounts.google.com/o/oauth2/auth?...
✓ Authenticated as alice@example.com
✓ Grant created: grant_abc123
✓ Set as active accountTroubleshooting
OAuth fails or times out
Ensure you're using a supported browser. Try clearing cookies for the auth domain.
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 login --help for full help output.