jiandaoyun-cli

简道云 API 命令行工具，通过终端管理应用数据、审批流程、通讯录、文件等，让终端成为你的简道云开发工作台。

特性

• 🚀 全功能覆盖 — 应用管理、数据 CRUD、流程审批、通讯录、文件上传
• 🔍 智能查找 — 支持按应用名/表单名模糊匹配，不再需要翻页面找 ID
• ⚡ 批量处理 — 批量创建/更新/删除，数据导入导出高效便捷
• 📋 流程审批 — 审批、退回、转交、加签、撤回，无需离开终端
• 📝 JSON 输出 — 所有命令支持 --json，方便脚本集成和 CI/CD
• 💾 智能缓存 — 应用表单列表缓存，避免频繁调用 API
• 🔄 限流自愈 — 遇到简道云限流自动等待重试，无需手动处理

安装

npm install -g jiandaoyun-cli

安装后即可使用 jdy 命令：

jdy --version

快速开始

配置认证：

# 方式一：持久化（推荐）
jdy config set apiKey eyJ...

# 方式二：环境变量
export JDY_API_KEY=eyJ...

# 方式三：命令行指定
jdy --api-key eyJ... app list

探索你的应用：

# 列出所有应用
jdy app list

# 按名称查找
jdy app list --name "资产管理"

# 查看流程列表
jdy app entries --type workflow

# 直接按名称查询数据
jdy data list --app-name "<应用名>" --form-name "<表单名>"

命令分类

应用管理

查询应用信息、表单列表、流程列表，支持名称模糊匹配。

jdy app list --name "资产"          # 搜索应用
jdy app entries --type workflow     # 列出所有流程
jdy app form-list --app-name "<应用名>" --form-name "<表单名>"  # 按名查找表单

数据管理

完整的 CRUD 操作，支持条件过滤、字段筛选、自动翻页。

jdy data list <appId> <entryId> --limit 10        # 查询
jdy data create <appId> <entryId> --data '{...}'  # 新建
jdy data batch-create <appId> <entryId> --file data.json  # 批量导入
jdy data update <appId> <entryId> <dataId> --data '{...}'  # 更新
jdy data batch-delete <appId> <entryId> --ids "id1,id2"   # 批量删除

流程管理

流程实例查询、任务审批、抄送管理，覆盖所有流程操作。

jdy workflow task-list --username zhangsan         # 待办列表
jdy workflow task approve <taskId> -i <id> -c "同意"  # 审批通过
jdy workflow task reject <taskId> -i <id>           # 退回
jdy workflow task transfer <taskId> --to "李四"     # 转交

通讯录

成员、部门、角色的只读查询和写入操作。

jdy addressbook user-get zhangsan       # 成员详情
jdy addressbook dept-list --tree        # 部门树
jdy addressbook user-create "张三" -u "zhangsan"  # 创建成员

其他

| 命令 | 说明 | |------|------| | jdy file upload | 上传文件到表单附件字段 | | jdy usage overview | 查询平台用量统计 | | jdy audit-log list | 查询审计日志 |

设计原则

• 终端优先 — 所有操作通过命令行完成，无需打开浏览器
• 脚本友好 — --json 输出，轻松集成到自动化流程
• 容错自愈 — API 限流自动重试，错误信息清晰可读
• 渐进学习 — 常用命令直觉式命名，详细文档在 USAGE.md

技术细节

• 语言：TypeScript + Node.js
• 构建：TypeScript 编译，零运行时依赖
• 认证：Bearer Token（简道云 API Key）
• 限流处理：自动检测 400/429 限流响应，指数退避重试

文档

• 完整操作手册 → USAGE.md
• 简道云官方 API 文档 → https://open.jiandaoyun.com

许可

MIT