Reference
Command Reference
Every command, subcommand, and flag in the Nylas CLI. Use nylas [command] --help for details on any command.
Global Flags
Flags available on every command.
| Command | Description |
|---|---|
| --json | Output as JSON |
| --no-color | Disable color output |
| --verbose / -v | Enable verbose output |
| --config PATH | Custom config file path |
| --help / -h | Show help for any command |
| --limit N | Limit results (most list commands) |
| --yes / -y | Skip confirmations |
Authentication
Manage API credentials and connected accounts.
| Command | Description |
|---|---|
| nylas auth config | Configure API credentials |
| nylas auth login | Authenticate with a provider |
| nylas auth list | List connected accounts |
| nylas auth show [grant-id] | Show account details |
| nylas auth status | Check authentication status |
| nylas auth whoami | Show current user info |
| nylas auth switch | Switch active account |
| nylas auth logout | Logout current account |
| nylas auth remove | Remove account completely |
| nylas auth token | Display current API token |
| nylas auth scopes [grant-id] | Show granted OAuth scopes |
| nylas auth providers | List available providers |
| nylas auth migrate | Migrate from v2 to v3 |
Send, read, search, and manage email messages.
| Command | Description |
|---|---|
| nylas email list [grant-id] | List recent emails |
| nylas email read <id> | Read a specific email |
| nylas email send --to EMAIL --subject S --body B | Send an email |
| nylas email search --query Q | Search emails |
| nylas email delete <id> | Delete an email |
| nylas email mark read <id> | Mark as read |
| nylas email mark starred <id> | Star a message |
| nylas email smart-compose --prompt P | AI-powered email draft |
| nylas email ai analyze | AI inbox summary |
| nylas email templates list | List email templates |
| nylas email drafts list | List drafts |
| nylas email folders list | List folders |
| nylas email threads list | List threads |
| nylas email scheduled list | List scheduled emails |
| nylas email attachments list <id> | List attachments |
| nylas email metadata show <id> | Show message metadata |
Calendar
Manage calendars, events, availability, and AI scheduling.
| Command | Description |
|---|---|
| nylas calendar list | List all calendars |
| nylas calendar events list [--days N] | List upcoming events |
| nylas calendar events show <id> | Show event details |
| nylas calendar events create --title T --start S --end E | Create an event |
| nylas calendar events update <id> | Update an event |
| nylas calendar events delete <id> | Delete an event |
| nylas calendar events rsvp <id> --status yes | RSVP to an event |
| nylas calendar availability check | Check availability |
| nylas calendar find-time --participants P --duration D | Find meeting time |
| nylas calendar schedule ai "..." | AI natural language scheduling |
| nylas calendar analyze | AI meeting analytics |
| nylas calendar ai conflicts --days N | Detect conflicts |
| nylas calendar ai reschedule <id> | AI-powered reschedule |
Contacts
Manage contacts and contact groups.
| Command | Description |
|---|---|
| nylas contacts list | List contacts |
| nylas contacts show <id> | Show contact details |
| nylas contacts create --name N --email E | Create a contact |
| nylas contacts search --query Q | Search contacts |
| nylas contacts sync | Sync contacts |
| nylas contacts groups list | List contact groups |
Webhooks
Create and manage webhooks for real-time event notifications.
| Command | Description |
|---|---|
| nylas webhook list | List all webhooks |
| nylas webhook create --url URL --triggers T | Create a webhook |
| nylas webhook update <id> | Update a webhook |
| nylas webhook delete <id> | Delete a webhook |
| nylas webhook triggers | List available trigger types |
| nylas webhook test send URL | Send test payload |
| nylas webhook server | Start local webhook server |
MCP (Model Context Protocol)
Connect AI assistants to your email and calendar.
| Command | Description |
|---|---|
| nylas mcp install | Interactive assistant setup |
| nylas mcp install --assistant claude-code | Install for Claude Code |
| nylas mcp install --assistant cursor | Install for Cursor |
| nylas mcp install --all | Install for all assistants |
| nylas mcp status | Check installation status |
| nylas mcp uninstall --assistant A | Remove configuration |
| nylas mcp serve | Start MCP server |
AI Features
Privacy-first AI assistant with local and cloud providers.
| Command | Description |
|---|---|
| nylas ai config | Configure AI provider |
| nylas email ai analyze | AI inbox analysis |
| nylas email smart-compose --prompt P | AI email compose |
| nylas calendar schedule ai "..." | Natural language scheduling |
| nylas calendar analyze | Meeting pattern analytics |
| nylas calendar find-time ... | AI meeting time finder |
Timezone Utilities
100% offline timezone tools. No API key required.
| Command | Description |
|---|---|
| nylas timezone list | List all timezones |
| nylas timezone convert --from PST --to EST | Convert time between zones |
| nylas timezone dst --zone ZONE | Check DST transitions |
| nylas timezone find-meeting --zones Z | Find cross-timezone meeting times |
| nylas timezone info ZONE | Get timezone info |
Inbound Email
Receive emails at managed addresses without OAuth.
| Command | Description |
|---|---|
| nylas inbound list | List inbound inboxes |
| nylas inbound create | Create an inbox |
| nylas inbound messages <id> | List messages in inbox |
| nylas inbound monitor | Real-time message monitoring |
Slack Integration
Interact with Slack workspaces from the CLI.
| Command | Description |
|---|---|
| nylas slack auth set --token T | Store Slack token |
| nylas slack channels list | List channels |
| nylas slack messages list --channel C | List messages |
| nylas slack messages send --channel C --text T | Send a message |
| nylas slack messages search --query Q | Search messages |
| nylas slack users list | List workspace users |
| nylas slack status set --text T | Set your status |
Other Commands
TUI, Web UI, Air, demo mode, workflows, and more.
| Command | Description |
|---|---|
| nylas tui | Launch interactive terminal UI |
| nylas ui | Start web configuration UI |
| nylas air | Launch full email client in browser |
| nylas demo email list | Try with sample data (no auth) |
| nylas workflow otp list | List OTP codes |
| nylas completion bash | Generate shell completions |
Guides
Send Email from Terminal
Complete walkthrough with scripting examples
E2E Email Testing
Verify emails in Playwright with Nylas Inbound
AI Agent Email Access via MCP
Set up Claude, Cursor, or VS Code
Build an Agent with Email Tools
Add email and calendar tools to your custom LLM agent
GPG Encrypted Email
Sign, encrypt, and verify from the CLI
Manage Calendar from CLI
Events, DST detection, AI scheduling