Reference
Command Reference
The CLI ships 246 commands organized into 26 categories: email, calendar, contacts, authentication, MCP, Notetaker, Slack, webhooks, dashboard, AI chat, and more. Every command supports --json output for piping into jq, --help for inline docs, and reads from an encrypted config in ~/.config/nylas/. Run 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 |
Getting Started
First-time setup, account creation, and onboarding.
| Command | Description |
|---|---|
| nylas init | Guided setup wizard for first-time users |
| nylas init --api-key KEY | Quick setup with an existing API key |
| nylas init --api-key KEY --region eu | Quick setup targeting the EU region |
| nylas init --google | Start setup with Google SSO |
| nylas init --microsoft | Start setup with Microsoft SSO |
| nylas init --github | Start setup with GitHub SSO |
Dashboard
Manage your Nylas account, applications, API keys, and organizations.
AI Chat
Web-based AI chat interface for email, calendar, and contacts.
| Command | Description |
|---|---|
| nylas chat | Launch AI chat in your browser |
| nylas chat --agent claude | Chat using Claude |
| nylas chat --agent codex | Chat using Codex |
| nylas chat --agent ollama --model llama2 | Chat using a local Ollama model |
| nylas chat --port 8080 | Run on a custom port |
| nylas chat --no-browser | Start server without opening browser |
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.
Email Folders & Threads
Manage labels, folders, and conversation threads.
| Command | Description |
|---|---|
| nylas email folders list | List folders |
| nylas email folders show <folder-id> | Show folder details |
| nylas email folders create <name> | Create folder |
| nylas email folders rename <folder-id> <new-name> | Rename folder |
| nylas email folders delete <folder-id> | Delete folder |
| nylas email threads list | List threads |
| nylas email threads show <thread-id> | Show thread with all messages |
| nylas email threads search --query Q | Search threads |
| nylas email threads mark <id> --read | Mark thread as read |
| nylas email threads delete <id> | Delete thread |
Email Drafts & Scheduled
Manage draft messages and scheduled sends.
| Command | Description |
|---|---|
| nylas email drafts list | List drafts |
| nylas email drafts show <draft-id> | Show draft details |
| nylas email drafts create --to E --subject S | Create a draft |
| nylas email drafts send <draft-id> | Send a draft |
| nylas email drafts delete <draft-id> | Delete a draft |
| nylas email scheduled list | List scheduled emails |
| nylas email scheduled show <schedule-id> | Show scheduled email |
| nylas email scheduled cancel <schedule-id> | Cancel a scheduled send |
Email Signatures
Stored signatures attached on send for any grant.
| Command | Description |
|---|---|
| nylas email signatures list [grant-id] | List stored signatures |
| nylas email signatures show <id> [grant-id] | Show signature details |
| nylas email signatures create [grant-id] --name N --body B | Create a signature |
| nylas email signatures create [grant-id] --name N --body-file FILE | Create from file |
| nylas email signatures update <id> [grant-id] | Update a signature |
| nylas email signatures delete <id> [grant-id] --yes | Delete a signature |
Local Email Templates
Reusable templates stored on disk with {{variable}} placeholders.
| Command | Description |
|---|---|
| nylas email templates list | List local templates |
| nylas email templates create --name N --subject S --body B | Create a template |
| nylas email templates show <id> | Show template details |
| nylas email templates update <id> | Update a template |
| nylas email templates delete <id> | Delete a template |
| nylas email templates use <id> --to E | Send using a local template |
Hosted Templates
Application or grant-scoped templates managed via the Nylas API.
| Command | Description |
|---|---|
| nylas template list | List hosted templates |
| nylas template create --name N --subject S --body B | Create hosted template |
| nylas template show <id> | Show template details |
| nylas template update <id> | Update a template |
| nylas template delete <id> --yes | Delete a template |
| nylas template render <id> --data '{}' | Render with variables |
| nylas template render-html --body H --engine mustache --data '{}' | Render inline HTML body |
Hosted Workflows
Automated workflows triggered by Nylas events (e.g., bookings).
| Command | Description |
|---|---|
| nylas workflow list | List workflows |
| nylas workflow create --name N --template-id T --trigger-event booking.created | Create a workflow |
| nylas workflow show <id> | Show workflow details |
| nylas workflow update <id> | Update a workflow |
| nylas workflow delete <id> --yes | Delete a workflow |
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 list --timezone America/Los_Angeles --show-tz | List events in a specific timezone |
| 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 recurring list | List recurring events |
| nylas calendar virtual list | List virtual meetings |
| nylas calendar focus-time list | List focus time blocks |
| 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, contact groups, and contact photos.
| 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 update <id> --name N | Update a contact |
| nylas contacts delete <id> | Delete a contact |
| nylas contacts search --query Q | Search contacts |
| nylas contacts sync | Sync contacts |
| nylas contacts groups list | List contact groups |
| nylas contacts groups show <id> | Show group details |
| nylas contacts groups create <name> | Create a group |
| nylas contacts groups update <id> --name N | Update a group |
| nylas contacts groups delete <id> | Delete a group |
| nylas contacts photo download <id> | Download contact photo |
| nylas contacts photo info | Show contact photo metadata |
Webhooks
Create and manage webhooks for real-time event notifications.
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 |
Audit Logging
Track, query, and export a log of every CLI command execution.
| Command | Description |
|---|---|
| nylas audit init | Initialize audit logging |
| nylas audit logs enable | Enable audit logging |
| nylas audit logs disable | Disable audit logging |
| nylas audit logs status | Check whether logging is active |
| nylas audit logs show | View and filter audit log entries |
| nylas audit logs summary | View summary statistics |
| nylas audit logs clear | Clear all audit log entries |
| nylas audit export | Export audit logs to JSON or CSV |
| nylas audit config show | View current audit configuration |
| nylas audit config set <key> <value> | Set an audit configuration value |
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 |
Agent Email Identities
Receive (and send) at managed agent addresses with no OAuth. Replaces the deprecated nylas inbound surface.
| Command | Description |
|---|---|
| nylas agent account list | List agent accounts |
| nylas agent account create <email> | Create a managed identity |
| nylas email list | Read messages in the agent inbox |
| nylas webhook create --triggers message.created | Real-time inbound via webhooks |
| nylas agent status | Connector and account readiness |
Slack Integration
Interact with Slack workspaces from the CLI.
| Command | Description |
|---|---|
| nylas slack auth set --token T | Store Slack user token |
| nylas slack auth status | Show Slack auth status |
| nylas slack auth remove | Remove stored Slack token |
| nylas slack channels list | List channels |
| nylas slack channels list --all-workspace | List all workspace channels (slower) |
| nylas slack channels info <channel-id> | Show channel details |
| nylas slack messages list --channel C | List messages |
| nylas slack messages list --channel C --thread TS | Show thread replies |
| nylas slack send --channel C --text T | Send a message |
| nylas slack reply --channel C --thread TS --text T | Reply in a thread |
| nylas slack search --query Q | Search messages |
| nylas slack users list | List workspace users |
Notetaker (AI Meeting Bot)
Manage Nylas Notetaker bots that join Zoom, Google Meet, and Teams to record and transcribe.
| Command | Description |
|---|---|
| nylas notetaker list | List all notetakers |
| nylas notetaker list --state scheduled | Filter by state |
| nylas notetaker create --meeting-link URL | Create a notetaker for a meeting |
| nylas notetaker create --meeting-link URL --join-time "tomorrow 2pm" | Schedule a future join |
| nylas notetaker show <id> | Show notetaker details |
| nylas notetaker media <id> | Get recording and transcript URLs |
| nylas notetaker delete <id> | Cancel or delete a notetaker |
OTP (One-Time Password)
Retrieve OTP/verification codes from email automatically.
| Command | Description |
|---|---|
| nylas otp get | Get the latest OTP and copy it to clipboard |
| nylas otp get [email] | Get OTP from a specific account |
| nylas otp get --raw | Output only the code |
| nylas otp watch | Continuously watch for new OTP codes |
| nylas otp watch --interval 5 | Poll every N seconds |
| nylas otp list | List configured accounts |
| nylas otp messages | Show recent messages with OTP detection |
Agent Accounts
Create and manage Nylas-managed agent accounts, policies, and rules.
Scheduler (Booking Pages)
Manage scheduling pages, configurations, sessions, and bookings.
| Command | Description |
|---|---|
| nylas scheduler pages list | List scheduling pages |
| nylas scheduler pages show <id> | Show page details |
| nylas scheduler pages create | Create a booking page |
| nylas scheduler pages update <id> | Update a booking page |
| nylas scheduler pages delete <id> | Delete a booking page |
| nylas scheduler bookings list | List bookings |
| nylas scheduler bookings show <id> | Show booking details |
| nylas scheduler bookings confirm <id> | Confirm a booking |
| nylas scheduler bookings reschedule <id> | Reschedule a booking |
| nylas scheduler bookings cancel <id> | Cancel a booking |
| nylas scheduler configurations list | List configurations |
| nylas scheduler configurations show <id> | Show a configuration |
| nylas scheduler configurations create | Create a configuration |
| nylas scheduler configurations update <id> | Update a configuration |
| nylas scheduler configurations delete <id> | Delete a configuration |
| nylas scheduler sessions create | Create a booking session |
| nylas scheduler sessions show <id> | Show session details |
Admin (API Management)
Manage Nylas applications, callback URIs, connectors, credentials, and grants.
Other Commands
TUI, Web UI, Air, demo mode, config management, diagnostics, 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 air --encrypted | Run Air with encrypted local cache |
| nylas config list | Show all configuration |
| nylas config get <key> | Get a specific config value |
| nylas config set <key> <value> | Set a configuration value |
| nylas config reset | Reset all CLI configuration and credentials |
| nylas config reset --force | Reset without confirmation prompt |
| nylas config path | Show configuration file path |
| nylas version | Show CLI version |
| nylas doctor | Run system diagnostics |
| nylas update | Update the CLI to the latest version |
| nylas update --check | Check for updates without installing |
| nylas update --force | Force update even if on latest |
| nylas demo email list | Try email with sample data (no auth) |
| nylas demo calendar list | Try calendar with sample data |
| nylas demo contacts list | Try contacts with sample data |
| nylas demo notetaker list | Try notetaker with sample data |
| nylas demo tui | Interactive demo TUI |
| nylas completion bash | Generate Bash completion script |
| nylas completion zsh | Generate Zsh completion script |
| nylas completion fish | Generate Fish completion script |
| nylas completion powershell | Generate PowerShell completion script |
Guides
Send Email from Terminal
Complete walkthrough with scripting examples
E2E Email Testing
Verify emails in Playwright with managed agent accounts
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