wecom-cli完整指南:让人类与AI Agent都能在终端操作企业微信的官方CLI
【免费下载链接】wecom-cli企业微信开放平台命令行工具 — 让人类和 AI Agent 都能在终端中操作企业微信项目地址: https://gitcode.com/gh_mirrors/we/wecom-cli
wecom-cli 是企业微信开放平台的官方命令行工具(CLI),让人类和 AI Agent 都能在终端中操作企业微信:发消息、发邮件、建文档、管日程、开会议、处理待办,一条命令搞定。本指南面向新手,带你 5 分钟完成安装,快速上手全部核心功能。
wecom-cli 是什么?为什么值得装一个?
传统上,操作企业微信要么打开网页后台点点点,要么自己写代码调 API(申请凭证、签名、处理分页……劝退率极高)。wecom-cli 把这一切封装成了一条终端命令:
- 🧑对人类:像用
git一样用wecom-cli,查会话、发 Markdown 消息、搜文档、下载文件,全部命令化 - 🤖对 AI Agent:内置了 15 个 Agent Skills(见 skills/ 目录),大模型可以直接"读懂"每个能力的触发条件、工作流和参数示例,自动替你完成跨应用的办公任务
- 🔧对开发者:Rust 编写、跨平台(macOS / Linux / Windows x64),JSON 结构化输出,天然适合写脚本和 CI
一句话:它是企业微信的终端入口,也是AI Agent 操作企业微信的手。
快速安装:3 步跑通 wecom-cli
前置条件
| 项目 | 要求 |
|---|---|
| 平台 | macOS(x64/arm64)、Linux(x64/arm64)、Windows(x64) |
| Node.js | ≥ 18 |
| 企业微信账号 | 必须 |
| 机器人 Bot ID / Secret | 可选(也可以扫码授权) |
一键安装命令
# 1. 安装 CLI npm install -g @wecom/cli # 2. 安装 CLI Skill(AI Agent 场景必需) npx skills add WeComTeam/wecom-cli -y -g # 3. 配置凭证(交互式,仅需一次) wecom-cli auth init # 4. 查看授权状态 wecom-cli auth show💡 从源码构建(供开发者):克隆仓库后执行
cargo run -p wecom-cli -- --help即可,仓库结构说明见 docs/development.md。
两种授权方式怎么选?
| 方式 | 命令 | 适合谁 |
|---|---|---|
| 扫码接入(推荐) | wecom-cli auth init | 所有人,终端出二维码,企业微信扫码即可 |
| 手动接入 | wecom-cli auth init --manual | 服务器等无扫码条件的环境 |
凭证加密存储在本机(AES-256-GCM,见 crates/wecom-cli/src/auth/),只需配置一次。auth show --status只输出authorized/unauthorized单行,方便脚本判断。
核心功能一览:12 大企业微信品类全覆盖
wecom-cli 覆盖企业微信核心业务,wecom-cli --help可查看你当前账号实际可用的品类:
| 品类 | 能做什么 |
|---|---|
| 💬 消息 | 向单聊/群聊推送 Markdown、图片、文件、语音、视频 |
| 📧 邮件 | 发送、回复、转发、搜索、查看邮件详情 |
| 📄 文档 | 在线文档新建、导入、读取、追加与覆盖写入 |
| 📊 表格 | 在线表格新建/导入/读写,智能表格子表、字段、记录、视图、图表管理 |
| ✅ 待办 | 创建、分派、完成、删除待办 |
| 📅 日程 | 日程增删改查、闲忙查询、会议室预订 |
| 🎥 会议 | 创建/取消会议、查询详情、读取纪要与转写原文 |
| 💾 微盘 | 文件搜索、上传、下载 |
| 👤 通讯录 | 按姓名/拼音/别名搜索成员,获取部门与职务信息 |
完整命令参考见 docs/cli-reference.md,Skills 全部分工见 docs/skills.md。
日常使用:最常用的 6 类命令
1. 随时查看帮助(新手第一招)
wecom-cli --help # 列出所有品类 wecom-cli message --help # 列出 message 下的所有工具 wecom-cli message aibot sessions list --help # 查看某命令需要哪些参数服务目录是服务端动态下发的,帮助内容始终与实际能力同步,不用背命令。
2. 发消息:先查会话,再推送内容
# 查看机器人最近对话过的单聊/群聊 wecom-cli message aibot sessions list # 用返回的会话 ID 发送一条 Markdown 消息(--json 直接给请求体) wecom-cli message aibot messages send --json '{"chat_id":"...","msgtype":"markdown","markdown":{"content":"**周报**已生成 🎉"}}'3. 搜索与读取文档
# 搜索"周报"相关文档 wecom-cli doc search --json '{"keywords":["周报"],"limit":10}'4. 三个万能执行 flag
| Flag | 作用 | 典型场景 |
|---|---|---|
--dry-run | 只校验并打印将发送的请求,不实际调用 | 先预览再执行,避免误操作 |
--page-count <n> | 游标式自动分页,最多拉 n 页(NDJSON 输出) | 批量拉取列表 |
--output <file> | 响应体写入文件 | 大结果落盘 |
5. 让 AI Agent 替你干活
这是 wecom-cli 最有特色的部分。安装 Skills 后,任何支持 Agent Skills 的 AI 助手都能按标准流程操作企业微信。内置 15 个 Skill,每个都带完整的SKILL.md工作流说明,例如:
- wecomcli-calendar:建日程、查忙闲、订会议室
- wecomcli-email:搜索邮件、读取正文与附件
- wecomcli-smartsheet:管理智能表格数据与视图,附带 20+ 行业模板(见 skills/wecomcli-smartsheet/assets/templates/)
- wecomcli-pptx:从素材直接生成在线 PPT
- wecomcli-shared:所有业务 Skill 的公共前置检查(安装、版本、授权)
对 Agent 说一句"帮我给上周的会议建个跟进待办",它会自动完成查会议 → 查通讯录 → 创建待办的全流程。
6. 调试与集成利器
wecom-cli schema list # 列出所有服务及方法 schema wecom-cli schema get doc.search # 获取指定方法的 schema wecom-cli cache status # 查看服务发现缓存状态需要自定义接入点时,可通过WECOM_CLI_ACCESS_TOKEN、WECOM_CLI_LOG_LEVEL等环境变量控制行为,完整清单见 docs/cli-reference.md 的「环境变量」一节。
安全设计:你的凭证与文件有多安全?
- 🔐凭证加密:
auth init后凭证以 AES-256-GCM 加密存于~/.config/wecom/credentials.enc(0600 权限),密钥优先存系统 keyring - 📦文件沙箱:文件读写限制在当前工作目录与系统临时目录内,凭据目录(如
.ssh、.env、.git)一律拒绝,相关策略见 crates/wecom-fs/src/sandbox/ - 🧾结构化错误:错误以 JSON 输出到 stdout,日志走 stderr,脚本解析不脏乱;退出码
0/1/2语义清晰 - 📊数据收集透明:默认仅回传 Agent 程序名与调用链路用于问题定位,从源码构建时可一键关闭,详见 docs/data-collection.md
常见问题 FAQ
Q:提示unauthorized怎么办?执行wecom-cli auth init重新扫码授权,再wecom-cli auth show --status确认输出authorized。
Q:命令找不到 / 版本号不对?先跑wecom-cli --version确认 ≥ 1.2.1,不满足则重新npm install -g @wecom/cli。
Q:能在没有浏览器的服务器上部署吗?可以。使用wecom-cli auth init --manual手动输入 Bot ID 和 Secret,或用--noninteractive配合--output-qrcode把二维码导出成 PNG 拿过去扫。
Q:输出怎么接入自己的脚本?默认 stdout 是紧凑 JSON,配合--output落文件或 shell 重定向即可;批量列表用--page-count得到 NDJSON(每行一页)。
进阶:源码结构速览(面向开发者)
wecom-cli 是 Rust Cargo workspace,核心代码分四个 crate(详见 docs/development.md):
| 路径 | 职责 |
|---|---|
| crates/wecom/ | 核心库:客户端、服务发现、schema 指令解析、媒体上传等 |
| crates/wecom-cli/ | 可执行入口:auth 鉴权体系、配置、日志 |
| crates/wecom-transport/ | 传输层:HTTP 后端、长任务轮询、请求/响应信封 |
| crates/wecom-fs/ | 文件系统与沙箱策略 |
本地开发只需cargo check --workspace/cargo test --workspace即可全量检查与测试,端到端测试规范见 docs/e2e/FRAMEWORK.md。
总结
wecom-cli 用一条npm install -g @wecom/cli就把企业微信搬进了终端:
- ✅ 安装只需 3 步,凭证扫码一次配置终身受用
- ✅ 消息、邮件、文档、日程、会议、待办、微盘、通讯录,12 大品类命令全覆盖
- ✅ 内置 15 个 Agent Skills,让 AI 助手直接成为你的企业微信操作手
- ✅ 沙箱、加密、结构化错误等安全设计开箱即用
无论是想给办公流程提效的个人,还是希望让 AI Agent 接管重复办公任务的团队,wecom-cli 都是目前终端操作企业微信的最短路径。现在打开终端,输入wecom-cli --help,开始你的第一次调用吧 🚀
【免费下载链接】wecom-cli企业微信开放平台命令行工具 — 让人类和 AI Agent 都能在终端中操作企业微信项目地址: https://gitcode.com/gh_mirrors/we/wecom-cli
创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考