YoudaoNote CLI 快速上手

YoudaoNote CLI（命令行工具）让你无需打开客户端，在终端中直接操作有道云笔记——列出笔记、读取内容、创建笔记、搜索、剪藏网页，适合脚本自动化和 AI 工具链集成。

1. 三步开始使用

# 第一步：安装（无需 Node.js）
curl -fsSL https://artifact.lx.netease.com/download/youdaonote-cli/install.sh | bash

# 第二步：配置 API Key（将 YOUR_API_KEY 替换为你的密钥，获取方式见下方说明）
youdaonote config set apiKey YOUR_API_KEY

# 第三步：验证
youdaonote list

如何获取 API Key？
确保你的有道云笔记账号已绑定手机号（可在有道云笔记客户端账号设置中绑定）
打开 MCP 控制台，登录后创建 API Key
复制 API Key，替换上方命令中的 YOUR_API_KEY

安装遇到问题？请参阅安装指南。

2. 常用命令

列出笔记

youdaonote list                  # 列出根目录
youdaonote list -f <目录ID>      # 列出指定目录

读取笔记内容

youdaonote read <fileId>

fileId 可从 list 或 search 结果中获取。

创建笔记

youdaonote create -n "标题" -c "内容"
youdaonote create -n "空笔记"        # 省略 -c 则创建空笔记

搜索笔记

youdaonote search 关键词

获取最近收藏的笔记

youdaonote recent                # 默认返回 15 条
youdaonote recent -l 30          # 返回 30 条
youdaonote recent -c             # 同时输出正文

网页剪藏

youdaonote clip "https://example.com/article"
youdaonote clip "https://example.com/article" -f <目录ID>

Windows CMD 用户：URL 中含 & 符号时（如 ?a=1&b=2），必须用英文双引号括起整个 URL，否则 & 会被 CMD 识别为命令分隔符，导致：
URL 被截断（只保留第一个 & 之前的部分），剪藏内容不完整
& 后的参数被当作命令执行，出现「不是内部或外部命令」错误
正确写法：
youdaonote clip "https://example.com/article?a=1&b=2"

保存剪藏数据（clip-save）

接收外部生成的 HTML 剪藏 JSON（如浏览器插件输出），保存到有道云笔记。

{
  "title": "笔记标题",
  "bodyHtml": "<p>正文内容</p>",
  "sourceUrl": "https://example.com",
  "images": []
}

youdaonote clip-save --file result.json

Windows 编码说明：CLI 已自动处理文件和管道输入的 GBK/UTF-8 编码转换。但 echo {...} > file.json 在 CMD 中写出的是 GBK 文件，建议改用以下方式之一：
在 CMD 中先执行 chcp 65001（切换为 UTF-8 代码页），再写入文件
用记事本或 VS Code 另存为 UTF-8 格式
若仍有乱码（极少见），会有 stderr 提示

保存任意类型笔记（save）

支持 Markdown、思维导图等类型：

{
  "title": "笔记.md",
  "type": "md",
  "content": "# 标题\n\n正文内容"
}

youdaonote save --file note.json

3. 常见使用场景

用脚本批量查看笔记

youdaonote list
youdaonote list -f <目录ID>

在 CI/脚本中创建笔记

cat > note.json << 'EOF'
{
  "title": "构建报告.md",
  "type": "md",
  "content": "# 构建成功\n\n时间：2026-03-12"
}
EOF
youdaonote save --file note.json

剪藏网页到指定目录

youdaonote clip "https://example.com/article" -f <目录ID>

脚本中搜索并读取笔记

FILE_ID=$(youdaonote search "关键词" --json | jq -r '.[0].id')
youdaonote read "$FILE_ID"

4. 常见问题

现象	解决方案
`API Key 未配置`	执行 `youdaonote config set apiKey YOUR_KEY`
`clip-save` 报「缺少必填字段」	确保 JSON 包含 `title`、`bodyHtml`、`sourceUrl`
`save` 报「缺少必填字段」	确保 JSON 包含 `title`、`content`
JSON 解析失败（`Unterminated string`）	改用 `printf '%s\n' '...'`，或用 `--file` 从文件读取
Windows 下 `JSON Parse error`	使用 `--file` 从文件读取；或改用 PowerShell
Windows `clip` 后出现「'pc' 不是内部或外部命令」等错误	CMD 把 URL 中的 `&` 识别为命令分隔符，`&` 后的参数被当作命令执行；用英文双引号括起 URL：`youdaonote clip "https://..."`
Windows 保存笔记后标题/内容乱码	`echo > file.json` 在 CMD 中写出 GBK 文件（CLI 会自动尝试 GBK 解码，若仍乱码说明环境不支持）；先执行 `chcp 65001` 再写文件，或用 UTF-8 编辑器保存 JSON