Guide

Nylas CLI 入门指南

2 分钟内完成 Nylas CLI 设置。创建免费 Nylas 账户，从 Dashboard 获取 API 密钥，运行 nylas auth config。无需浏览器授权流程，支持 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 Dashboard 中的 API 密钥。五个步骤，不到 2 分钟，无需浏览器授权流程。

第 1 步：创建 Nylas 账户

在 dashboard-v3.nylas.com 注册。免费套餐包含 5 个连接账户，足够个人使用和测试。支持 Google、Microsoft 或 GitHub SSO 登录。

第 2 步：创建应用

在 Dashboard 中，进入 All apps → Create new app。选择名称和区域（US 或 EU）。每个应用支持无限数量的已连接邮箱账户（称为 grant），覆盖 Gmail、Outlook、Exchange、Yahoo、iCloud 和 IMAP。

第 3 步：获取 API 密钥

在 Dashboard 中打开你的应用，进入 API Keys 部分。点击 Create new key。复制密钥——它以 nyl_ 开头，下一步会粘贴到 CLI 中。

第 4 步：连接邮箱账户

继续在 Dashboard 中，进入应用的 Grants 部分，点击 Add Account。通过邮件提供商（Gmail、Outlook、Exchange、Yahoo、iCloud 或 IMAP）完成授权。这会创建一个 grant——即你的邮箱账户与 Nylas 应用之间的连接。

第 5 步：配置 CLI

运行 nylas auth config，在提示时粘贴 API 密钥。CLI 会通过 Nylas API 验证密钥，将其加密保存到 ~/.config/nylas/config.yaml，并同步你刚连接的 grant。

nylas auth config

如果你的 Nylas 应用在 EU 区域，请传入 --region eu：

nylas auth config --region eu

CLI 会确认密钥已保存并显示已连接的账户：

Paste your API key:
nyl_••••••••••••••••••••

> API key saved to system keyring
> Set user@gmail.com as default account

设置完成——运行以下命令列出收件箱，确认一切正常：

nylas email list

如何连接更多邮箱账户？

设置完成后要添加更多账户，前往 Nylas Dashboard， 打开应用的 Grants 部分，点击 Add Account。CLI 会在下次执行命令时自动识别新的 grant。

你也可以直接从 CLI 通过 OAuth 连接账户：

nylas auth login

这会打开浏览器进行授权。根据 Google 的 OAuth 2.0 文档，访问令牌在 3,600 秒后过期——CLI 会自动刷新。如果授权后浏览器流程卡住，请改用 Dashboard 方式。

管理已连接的账户：

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

# 切换账户
nylas auth switch

如何用一条命令完成设置？

nylas init --api-key 用一条非交互式命令配置 CLI—不需要浏览器认证流程，也没有 SSO 重定向，这与运行四个步骤的交互式向导不同。直接传入你的密钥，CLI 立即完成认证，这使它成为无界面环境的首选路径：CI/CD 流水线、Docker 容器，以及没有可用浏览器的 SSH 会话。

nylas init --api-key nyl_abc123

如果应用在 EU 区域，使用 --region eu：

nylas init --api-key nyl_abc123 --region eu

如何使用交互式设置向导？

nylas init 向导是上述 API 密钥流程的替代方案。它会引导你完成账户创建、应用选择、API 密钥生成和 grant 同步，全部在一个交互会话中完成。需要浏览器进行 SSO 认证。

nylas init

要跳过 SSO 提供商选择菜单，直接传入对应参数：

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

如何从 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 的脚本。

下一步