wecom-cli快速上手教程:5分钟完成安装、扫码授权与首次API调用
【免费下载链接】wecom-cli企业微信开放平台命令行工具 — 让人类和 AI Agent 都能在终端中操作企业微信项目地址: https://gitcode.com/gh_mirrors/we/wecom-cli
wecom-cli 是企业微信官方命令行工具(CLI),覆盖消息、邮件、文档、日程、会议、待办、微盘、通讯录等核心办公能力。它让人类和 AI Agent 都能在终端中直接操作企业微信,无需手动登录网页后台。本文面向新手,带你用 5 分钟完成 wecom-cli 安装、扫码授权,并发出第一次企业微信 API 调用。
wecom-cli 是什么?它能帮你做什么
wecom-cli 用 Rust 编写、通过 npm 包@wecom/cli分发,跨平台支持 macOS、Linux 和 Windows。它内置 12+ 个业务品类,常用能力一览:
| 品类 | 能做什么 |
|---|---|
| 💬 消息 | 向单聊/群聊主动推送 Markdown、图片、文件、语音、视频 |
| 📧 邮件 | 邮件搜索、读取正文与附件 |
| 📄 文档 / 📊 表格 | 新建、导入、读取、追加与覆盖写入在线文档和表格 |
| ✅ 待办 / 📅 日程 | 创建与跟进待办,日程增删改查、会议室预订 |
| 🎥 会议 | 预约会议、查询纪要与转写原文 |
| 💾 微盘 / 👤 通讯录 | 文件搜索与上传下载,按姓名搜索成员 |
完整功能说明见 README.md,命令细节见 docs/cli-reference.md。
安装前准备:3 个前置条件
开始之前,请确认你的环境满足以下要求(约 1 分钟):
- 操作系统:macOS (x64/arm64)、Linux (x64/arm64) 或 Windows (x64)
- Node.js ≥ 18:wecom-cli 依赖 npm 安装,可执行
node -v检查版本 - 一个企业微信账号:用于扫码授权绑定
💡 可选:如果你有企业微信智能机器人的 Bot ID 和 Secret,也可以用手动方式接入(后文会提到)。
一键安装 wecom-cli:只需两条命令
打开终端,执行以下命令完成安装:
# 安装 CLI npm install -g @wecom/cli # 安装 CLI Skill(AI Agent 集成必需) npx skills add WeComTeam/wecom-cli -y -g安装完成后验证版本:
wecom-cli --version看到类似wecom-cli 1.x.x (...)的输出即代表安装成功。npm 入口脚本会自动定位并执行当前平台的二进制文件(源码见 bin/wecom.js,各平台包位于 packages/ 目录)。
扫码授权:wecom-cli auth init 使用指南
wecom-cli 首次使用前需要完成一次凭证授权,全程只需一条命令:
wecom-cli auth init命令支持两种接入方式,交互式选择:
- 扫码接入(推荐):终端展示二维码,用企业微信手机 App 扫码即可完成绑定,等待超时时间为 5 分钟
- 手动接入:加
--manual参数,手动输入 Bot ID 和 Secret
几个实用的授权参数:
| 参数 | 说明 |
|---|---|
--noninteractive | 跳过交互直接扫码,适合 CI/脚本环境 |
--no-browser | 扫码时不自动打开浏览器 |
--output-qrcode <PATH> | 将二维码保存为 PNG 文件 |
--manual | 手动输入 Bot ID 和 Secret |
授权状态随时可查:
wecom-cli auth show # 查看 Status 与 Bot ID wecom-cli auth show --status # 仅输出 authorized / unauthorized,便于脚本判断凭据经 AES-256-GCM 加密存储在本机~/.config/wecom/credentials.enc,密钥优先存放在系统 keyring,安全性有保障(实现见 crates/wecom-cli/src/auth/ 目录)。
首次 API 调用:5 分钟跑通第一个请求
授权成功后,就可以发起第一次企业微信 API 调用了。命令模型统一为:
wecom-cli <service> [resource...] <method> [flags]其中service由服务端动态下发,常见品类包括message(消息)、doc(文档)、contact(通讯录)等。来试几个典型示例:
# 查询机器人最近对话过的会话列表 wecom-cli message aibot sessions list # 搜索名为"周报"的文档 wecom-cli doc search --json '{"keywords":["周报"],"limit":10}'响应默认以 compact JSON 输出到 stdout,方便管道处理;出错时同样输出结构化 JSON,且退出码有明确约定:0成功、1运行时错误、2用法错误。
想先"预演"请求而不真正发送?加上--dry-run即可在本地校验并打印将发送的请求:
wecom-cli doc search --json '{"keywords":["周报"]}' --dry-run进阶技巧:让 AI Agent 替你操作企业微信
wecom-cli 的一大亮点是内置了 15 个 Agent Skills(见 docs/skills.md),让 AI 助手可以直接在终端替你完成业务操作,例如:
- wecomcli-calendar:创建日程、查询闲忙、预订会议室
- wecomcli-todo:创建、跟进、完成待办
- wecomcli-email:搜索邮件并读取正文
- wecomcli-doc:新建文档、追加与覆盖正文
所有业务技能执行前都会先读取 wecomcli-shared,自动检查安装、版本与授权状态,未授权时会引导你完成初始化——无需手动重复配置。
遇到问题怎么办?常见问题速查
| 症状 | 解决方法 |
|---|---|
command not found: wecom-cli | 重新执行npm install -g @wecom/cli,确认 Node.js ≥ 18 |
授权提示unauthorized | 执行wecom-cli auth init重新扫码,5 分钟内完成 |
| 命令找不到 / 参数报错(退出码 2) | 用wecom-cli <service> --help查看该品类可用工具与参数 |
| 网络或服务异常(退出码 1) | 检查网络;错误 JSON 中的code可直接用于定位 |
更多细节参考:
- 完整命令参考与运行时路径:docs/cli-reference.md
- 数据收集说明:docs/data-collection.md
- 本地开发指南:docs/development.md
总结
wecom-cli 快速上手三步走:
- ✅
npm install -g @wecom/cli一键安装 - ✅
wecom-cli auth init企业微信扫码授权 - ✅
wecom-cli message aibot sessions list发出第一个 API 调用
至此,你已拥有在终端里直接操作企业微信的能力——无论是发消息、查文档还是约会议,一条命令即可完成。祝使用愉快!🎉
【免费下载链接】wecom-cli企业微信开放平台命令行工具 — 让人类和 AI Agent 都能在终端中操作企业微信项目地址: https://gitcode.com/gh_mirrors/we/wecom-cli
创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考