ACORG docs

主题

钉钉 CLI ​

钉钉 CLI 即 DingTalk Workspace CLI,命令为 dws,用于在终端和 AI Agent 中操作钉钉工作台能力。

适用场景 ​

  • 查询通讯录、日程、待办、审批、考勤、汇报和会议纪要。
  • 读取或管理钉钉文档、钉盘、知识库、在线表格和 AI 表格。
  • 让 Agent 根据钉钉上下文生成日报、会议摘要、待办清单或部门信息汇总。
  • 在企业授权和审计约束下调用钉钉开放平台 API。
  • 需要通过 schema、jq、dry-run 等能力降低 Agent 调用错误和误操作风险。

能力范围 ​

类别能力
组织与沟通通讯录、聊天、群组、机器人消息、DING 消息
办公流程日程、待办、审批、考勤、汇报、会议纪要
内容与文件文档、钉盘、知识库、邮件、在线表格
数据协作AI 表格、数据表、字段、记录、视图、仪表盘、导入导出
平台能力OpenAPI 调用、schema 发现、jq 过滤、dry-run、自升级

安装与登录 ​

macOS / Linux:

bash
curl -fsSL https://raw.githubusercontent.com/DingTalk-Real-AI/dingtalk-workspace-cli/main/scripts/install.sh | sh

Windows PowerShell:

powershell
irm https://raw.githubusercontent.com/DingTalk-Real-AI/dingtalk-workspace-cli/main/scripts/install.ps1 | iex

也可以通过 npm 安装:

bash
npm install -g dingtalk-workspace-cli

登录:

bash
dws auth login
dws auth login --device
dws auth status

钉钉 CLI 当前涉及企业数据访问,通常需要组织开启 CLI 访问并由管理员授权。组织未开启时,用户需要按提示向管理员申请。

Agent Skill 模式 ​

钉钉 CLI 支持两种 Skill 组织方式:

模式安装内容适合场景
mono一个 dws Skill 覆盖全部产品跨产品工作流,需要主动切换
multi多个产品级 Skill默认安装布局,单产品任务上下文更小

按官方 README 当前说明,安装器和升级默认采用 multi。如果确实需要单一 Skill,可在安装后切换为 mono:

bash
dws skill setup --mode mono

切换前先查看安装器列出的目标目录和覆盖计划；以当前 dws skill setup --help 与官方 README 为准。

常用能力 ​

bash
dws contact user search --query "engineering"
dws calendar event list
dws doc search --query "quarterly"
dws minutes list mine
dws drive list
dws todo task list --dry-run

Agent 使用只读查询和 --dry-run 先确认参数:

bash
dws contact user search --query "张三" --dry-run
dws contact user get-self --jq '.result[0].orgEmployeeModel | {name: .orgUserName, userId}'

创建待办、发送消息等写操作应在核对目标账号、权限、参数及预览结果后,由有权限的用户明确确认；不要把带 --yes 的写命令当作初次接入测试。

Schema 发现 ​

Agent 不需要预先记住所有命令,可以通过 schema 动态发现产品和参数:

bash
dws schema --jq '.products[] | {id, tool_count: (.tools | length)}'
dws schema aitable.query_records --jq '.tool.parameters'
dws schema aitable.query_records --jq '.tool.auth'
dws aitable record query --base-id BASE_ID --table-id TABLE_ID --limit 10

升级 ​

dws 提供自升级能力:

bash
dws upgrade --check
dws upgrade
dws upgrade --list
dws upgrade --version v1.0.7
dws upgrade --rollback

升级过程会先下载和校验平台二进制与 Skill 包,成功后再替换现有文件,并保留备份用于回滚。

安全建议 ​

  1. 上线前确认组织已开启 CLI 访问,并明确管理员审批流程。
  2. 优先使用最小权限应用,不要把企业高权限账号直接暴露给长期自动化任务。
  3. 写操作统一要求 --dry-run 或先输出计划,再由用户确认。
  4. 使用 --jq 或 --fields 控制输出字段,减少敏感信息暴露和 Token 消耗。
  5. 不要绕过默认域名白名单、HTTPS、凭证加密和审计链路。

提示词示例 ​

text
请使用 dws 只读查询我今天的日程、待办和会议纪要,
整理为一份日报草稿。
不要创建、更新、删除任何钉钉数据。
text
请先用 dws schema 查看创建待办所需参数,
再用 --dry-run 预览调用。
等我确认标题、执行人和截止时间后再执行。

参考链接 ​