Guide

Nylas CLI 入门指南

2 分钟内完成 Nylas CLI 设置。运行 nylas init 进行引导式注册并连接邮箱，或使用 nylas auth config 通过已有的 API 密钥登录。支持 macOS、Linux 和 Windows。

Written by Prem Keshari Senior SRE

Reviewed by Caleb Geene

Verified — CLI 3.1.1 · Gmail, Outlook, IMAP · last tested April 11, 2026

如何安装 Nylas CLI？

Nylas CLI 是一个 12 MB 的静态二进制文件，没有运行时依赖。选择适合你平台的安装方式——每种方式都会自动检测 CPU 架构（x86_64 或 arm64），从 GitHub 下载对应的构建版本，并通过 SHA-256 校验和验证下载完整性。大多数网络环境下安装在 30 秒内完成。

Homebrew（macOS 和 Linux）

Homebrew formula 使用 nylas/nylas-cli 仓库，并锁定最新稳定版本。运行 brew upgrade 时 Homebrew 会自动处理升级。

brew install nylas/nylas-cli/nylas

Shell 脚本（macOS、Linux、WSL）

Shell 安装器适用于任何 POSIX 系统，包括 WSL。它将二进制文件写入 ~/.config/nylas/bin，并输出一行 PATH 导出命令，你可以添加到 Shell 配置文件中。

curl -fsSL https://cli.nylas.com/install.sh | bash

PowerShell（Windows）

PowerShell 安装器下载 Windows 二进制文件并将安装目录添加到用户级 PATH。需要 PowerShell 5.1 或更高版本，Windows 10 和 11 已自带。

irm https://cli.nylas.com/install.ps1 | iex

Go

从源码编译需要 Go 1.23 或更高版本。二进制文件会安装到 $GOPATH/bin 目录。

go install github.com/nylas/cli/cmd/nylas@latest

使用任意方式安装后，运行以下命令确认二进制文件已添加到 PATH：

nylas --version

安装后如何设置 Nylas CLI？

安装完成后有两条设置路径。新用户运行 nylas init，这是一个交互式向导，会创建 Nylas 账户、构建应用、生成 API 密钥，并在同一会话中连接你的第一个邮箱账户。如果你已经有 API 密钥，运行 nylas auth config 登录即可。使用 nylas auth login 添加邮箱——免费套餐最多可连接 5 个账户。

如何使用 nylas init 设置？

nylas init 向导是新用户最快的路径。它在一个交互会话中完成四个步骤：登录或创建 Nylas 账户、选择或创建应用、生成并激活 API 密钥，然后同步你已有的邮箱账户。整个流程约 90 秒，期间会打开一次浏览器进行 SSO 登录。

nylas init

向导会提示选择 SSO 提供商（Google、Microsoft 或 GitHub），然后引导你完成应用和密钥的创建，最后连接邮箱。要跳过提供商选择菜单，直接传入对应参数：

nylas init --google
nylas init --microsoft
nylas init --github

向导完成后，你的账户已认证，邮箱也已连接。运行以下命令列出收件箱以确认：

nylas email list

如何使用已有的 API 密钥登录？

已经从 Nylas Dashboard 获取了 API 密钥？运行 nylas auth config，在提示时粘贴密钥即可登录—这会跳过四步向导。CLI 会在 1 秒内验证密钥并加密保存，无需浏览器或 SSO 重定向，非常适合 CI/CD 流水线、Docker 容器和 SSH 会话。

nylas auth config

以参数形式传入密钥可实现非交互式设置；如果你的应用在 EU 区域，请加上 --region eu。密钥以 nyl_ 开头：

nylas auth config --api-key nyl_abc123
nylas auth config --api-key nyl_abc123 --region eu

如何从 Dashboard 获取 API 密钥？

刚接触 Nylas 但更喜欢用 Dashboard 而非向导？三个步骤生成 API 密钥，然后用上面的 nylas auth config 登录。免费套餐包含 5 个连接账户，无需信用卡。

  1. 注册，在 dashboard-v3.nylas.com 使用 Google、Microsoft 或 GitHub SSO 登录。
  2. 创建应用—打开 All apps，新建一个应用，并选择区域（US 或 EU）。
  3. 生成 API 密钥—打开应用的 API Keys 部分，点击 Create new key。密钥以 nyl_ 开头。

使用密钥登录会让 CLI 针对你的应用完成认证，但此时还没有连接任何邮箱。运行 nylas auth login 连接你的第一个邮箱账户——这与后续添加更多账户用的是同一条命令（下一节介绍）。

如何连接邮箱账户？

使用 nylas auth login 连接邮箱。免费套餐最多可连接 5 个账户（称为 grant），覆盖 Gmail、Outlook、Exchange、Yahoo、iCloud 和 IMAP。Google 是默认提供商，因此不带参数时会启动 Google 登录；其他五个提供商请传入 --provider。CLI 会在下次执行命令时自动识别每个新 grant。

# OAuth 提供商（会打开浏览器）
nylas auth login --provider google
nylas auth login --provider microsoft
nylas auth login --provider ews

# 凭据提供商（应用专用密码）
nylas auth login --provider icloud
nylas auth login --provider yahoo
nylas auth login --provider imap

根据 Google 的 OAuth 2.0 文档，访问令牌在 3,600 秒后过期。CLI 会保存 grant 并自动刷新令牌，因此你只需授权一次。列出并切换已连接的账户：

# 列出所有已连接的账户
nylas auth list

# 切换活动账户
nylas auth switch

如何从 CLI 管理账户？

Nylas CLI 通过 nylas dashboard 子命令覆盖了约 90% 的 Web Dashboard 功能。你可以创建应用、轮换 API 密钥、切换组织、检查登录状态，无需打开浏览器。每个子命令都支持 --json 输出，方便脚本使用。

常用的 Dashboard 操作：

# 检查登录状态
nylas dashboard status

# 列出应用
nylas dashboard apps list

# 创建新应用
nylas dashboard apps create --name "Production App" --region us

# 设置活动应用
nylas dashboard apps use app_abc123

# 生成新 API 密钥
nylas dashboard apps apikeys create

# 切换组织
nylas dashboard orgs switch

如何使用邮件、日历和联系人？

Nylas CLI 将 72+ 条命令组织为三个核心分组：邮件（发送、列表、搜索、草稿、附件）、日历（事件、可用性、日程安排）和联系人（列表、搜索、分组）。每个分组支持 --json 输出和 --limit 控制返回数量。以下是设置完成后最常用的命令：

# 邮件：列表、搜索和发送
nylas email list --limit 5
nylas email search "quarterly report"
nylas email send --to colleague@company.com --subject "Quick note" --body "See you at 2pm."

# 日历：列出事件和查看可用性
nylas calendar events list --days 7
nylas calendar availability check --start 2026-05-12T09:00:00Z --end 2026-05-12T17:00:00Z --participants colleague@company.com

# 联系人：列表和搜索
nylas contacts list --limit 10
nylas contacts search --query "Alice"
nylas contacts groups list

在任何命令后添加 --json 可获取结构化输出，可以通过管道传给 jq、输入脚本或传递给 AI 代理。 发送邮件指南和 日历指南对每个分组有详细介绍。

如何重置并重新开始？

Nylas CLI 将所有配置存储在 ~/.config/nylas/ 目录中——通常 3-4 个文件，总计不到 2 KB。重置会移除 API 凭据、Dashboard 会话令牌、已认证的 grant 和配置文件，但不会影响你在 Nylas Dashboard 上的数据或服务端已连接的账户。你的应用、grant 和 API 密钥在云端保持不变。

清除本地配置并重新设置：

nylas config reset
nylas init

使用 --force 可跳过确认提示，适用于需要自动重新配置 CLI 的脚本。

下一步