Yuque CLI

一个基于 Node.js 的语雀命令行工具，提供沉浸式交互 REPL。

主要能力：

• 常驻 Banner 的应用式界面
• 键盘优先的交互体验
• 知识库与文档的表格/列表选择
• 文档 open（浏览器打开）和 show（终端展示）
• Markdown 分页预览
• 文档创建时的多行正文编辑器

English docs: README.md

功能特性

• 支持 YUQUE_TOKEN 环境变量和交互式登录
• 丰富键盘交互（翻页、选择、确认、取消）
• 支持命令补全与建议下拉
• 语雀 namespace 列支持终端可点击链接（OSC8 终端）
• 提示文案友好，错误反馈更可操作
• create doc in [repo] 使用多行编辑器输入正文

环境要求

• Node.js >= 18

安装

npm install -g yuque-cli

验证

yuque --version

鉴权

• 环境变量：YUQUE_TOKEN
• 或在 REPL 中执行：auth login

Token 默认保存位置：

~/.yuque/settings.json

创建 Token 页面：

https://www.yuque.com/settings/tokens

使用

yuque

或执行单次命令：

yuque whoami
yuque list repos
yuque list docs <repo>
yuque open <repo>/<doc>
yuque show <repo>/<doc>
yuque search "keyword" <repo>

环境变量

• YUQUE_TOKEN：语雀 token
• YUQUE_ENDPOINT：自定义 API 地址（默认 https://www.yuque.com）

开发

npm test
npm run repl

License

MIT