@wecom/cli
v0.1.6
Published
The official CLI for WeCom
Downloads
13,083
Readme
wecom-cli
💬 扫码加入企业微信交流群:
企业微信命令行工具 — 让人类和 AI Agent 都能在终端中操作企业微信。
功能范围
覆盖企业微信核心业务品类:
| 品类 | 能力 |
| ----------- | ----------------------------------------------------------------------------- |
| 📄 文档 | 文档创建、读取、编辑等;智能文档创建、读取 |
| 📊 智能表格 | 智能表格创建、子表与字段管理、记录增删改查等 |
| 💬 消息 | 会话列表查询、消息记录拉取(文本/图片/文件/语音/视频)、多媒体下载、发送文本等 |
| 👤 通讯录 | 获取可见范围成员列表、按姓名/别名搜索等 |
| ✅ 待办 | 创建/读取/更新/删除待办,变更用户处理状态等 |
| 🎥 会议 | 创建预约会议、取消会议、更新受邀成员、查询列表与详情等 |
| 📅 日程 | 日程增删改查、参与人管理、多成员闲忙查询等 |
企业场景: 对于10人以上规模的企业,企业微信为API模式智能机器人提供了文档CLI能力,机器人可以创建及读取文档、智能表格及智能文档,提高企业场景下的办公效率。
个人/小团队场景: 对于10人及以下的个人/小团队,企业微信为API模式智能机器人提供了消息、文档、日程、会议、待办等CLI能力,以满足个人或小团队提效场景。
快速开始
前置条件
- 支持平台:macOS (x64/arm64)、Linux (x64/arm64) 及 Windows (x64)
- Node.js
>= 18 - 企业微信账号
- (可选)智能机器人 Bot ID 和 Secret,获取方式参考 说明
安装 & 使用
# 安装 CLI
npm install -g @wecom/cli
# 安装 CLI Skill(必需)
npx skills add WeComTeam/wecom-cli -y -g
# 配置凭证(交互式,仅需一次)
wecom-cli init
# 获取通讯录可见范围内的成员列表
wecom-cli contact get_userlist '{}'📖 更多使用方法,请参阅 CLI 命令参考。
Agent Skills
🤖 支持的 Skills 使用说明,请参阅 Skills 文档。
许可证
本项目基于 MIT 许可证 开源。
