YoudaoNote CLI 安装指南
1. 安装
支持平台:macOS(Intel / Apple Silicon)、Linux(x64 / ARM64)、Windows(x64 / ARM64)。其中 macOS 与 Linux 可使用下方一键脚本;Windows 需手动下载预编译包(见「Windows」小节)。
1.1 macOS / Linux(一键安装)
在终端运行以下命令,无需安装 Node.js:
curl -fsSL https://artifact.lx.netease.com/download/youdaonote-cli/install.sh | bash
安装完成后,youdaonote 命令默认写入 /usr/local/bin。如需指定安装目录:
curl -fsSL https://artifact.lx.netease.com/download/youdaonote-cli/install.sh | bash -s -- -b ~/bin
安装选项(仅 macOS / Linux 脚本)
| 选项 | 说明 |
|---|---|
-b, --bin-dir DIR | 指定安装目录,默认 /usr/local/bin |
-f, -y, --force | 跳过确认提示,适用于 CI/脚本 |
Linux x86_64 说明
一键脚本会根据 CPU 是否支持 AVX2 自动选择「现代」或 baseline 安装包;无 AVX2 的旧机器也可正常安装。若仍出现 Illegal instruction,可在安装时使用:
curl -fsSL https://artifact.lx.netease.com/download/youdaonote-cli/install.sh | YOUDAONOTE_CLI_BASELINE=1 bash
(变量须写在管道右侧的 bash 上。)
Linux 安装失败?
若使用 Snap 版 curl 出现「Permission denied」或「下载失败」:
- 不要使用
sudo curl ... | bash,直接运行curl ... | bash - 若仍失败,换用系统原生 curl:
sudo apt install curl
# 或
sudo snap remove curl
1.2 Windows(手动下载)
install.sh 不支持 Windows。请按架构下载对应的压缩包,解压后将可执行文件加入 PATH。
下载 (任选其一)
- 64 位 Intel / AMD(常见台式机、笔记本)youdaonote-cli-windows-x64.tar.gz
- ARM64(如部分 Surface、Windows on ARM 设备) youdaonote-cli-windows-arm64.tar.gz
解压 解压后目录内为
windows-x64\youdaonote.exe或windows-arm64\youdaonote.exe(以实际架构为准)。Windows 10 及以上可在资源管理器中解压.tar.gz,或在 PowerShell 中进入下载目录执行:tar -xzf youdaonote-cli-windows-x64.tar.gz配置 PATH 将
youdaonote.exe所在文件夹(例如...\windows-x64)加入系统或用户的 环境变量 Path,或直接把youdaonote.exe复制到已在 PATH 中的目录(如自行创建的C:\Tools\youdaonote\)。验证 重新打开 CMD 或 PowerShell,执行:
youdaonote version
使用 WSL? 在 WSL 内可按 Linux 方式执行
curl ... | bash安装 Linux 版二进制,与 Windows 原生路径、配置文件相互独立。
2. 获取 API Key
访问 MCP 控制台 获取 API Key。
前提条件:有道云笔记账号需已绑定手机号,否则无法在控制台开通 API Key。可在有道云笔记客户端的账号设置中绑定。
3. 配置
方式一:命令行(推荐)
youdaonote config set apiKey YOUR_API_KEY
方式二:配置文件
在 ~/.youdaonote.json(Windows 为 %USERPROFILE%\.youdaonote.json,例如 C:\Users\你的用户名\.youdaonote.json)中写入:
{
"backend": "mcp",
"mcp": {
"server": "https://open.mail.163.com/api/ynote/mcp/sse",
"apiKey": "YOUR_API_KEY"
}
}
方式三:环境变量(优先级最高)
macOS / Linux:
export YOUDAONOTE_API_KEY=YOUR_API_KEY
Windows(PowerShell 当前会话):
$env:YOUDAONOTE_API_KEY = "YOUR_API_KEY"
Windows(CMD 当前会话):
set YOUDAONOTE_API_KEY=YOUR_API_KEY
持久化配置可在「系统属性 → 环境变量」中添加用户或系统变量。
4. 验证安装
在终端(macOS / Linux)或 CMD / PowerShell(Windows)中执行:
youdaonote list
能列出笔记目录即表示安装和配置成功。
5. 常见问题
| 现象 | 原因 | 解决方案 |
|---|---|---|
youdaonote 命令不存在 | 未安装或 PATH 未包含安装目录 | macOS / Linux:重新执行安装脚本;检查安装目录是否在 PATH 中。Windows:确认已解压 youdaonote.exe 且其所在目录已加入系统 Path,并重新打开终端 |
| Windows 提示无法运行或被杀软拦截 | 未签名 exe 偶发误报 | 将解压目录加入杀软信任,或改用 WSL 安装 Linux 版 |
Linux 安装失败(Permission denied) | Snap 版 curl 沙箱限制 | 不要使用 sudo curl;换用原生 curl(见上方说明) |
Linux 运行即 Illegal instruction | CPU 不支持预编译包所需指令集 | 使用带 YOUDAONOTE_CLI_BASELINE=1 的安装方式(见上方「Linux x86_64 说明」) |
API Key 未配置 | 未完成配置步骤 | 参照上方「配置」章节完成配置 |