WeCom CLI (企业微信 CLI)
Website: https://work.weixin.qq.com CLI Tool: wecom-cli NPM Package: @wecom/cli Repository: https://github.com/WecomTeam/wecom-cli License: MIT
Description
Official command-line tool for WeCom (企业微信), built for humans and AI agents. Covers 7 core business domains including Contact, Todo, Meeting, Messages, Schedule, Docs, and Smart Sheets (智能表格). Features 12 AI Agent Skills for seamless integration with Claude Code, Codex, and other AI tools.
Install
# Install CLI
npm install -g @wecom/cli
# Install CLI Skills (required)
npx skills add WeComTeam/wecom-cli -y -g
Setup
# Configure bot credentials (interactive, one-time)
wecom-cli init
Requires Bot ID and Secret from WeCom admin console.
Commands
| Command | Description |
|---|---|
wecom-cli init |
Configure credentials |
wecom-cli contact get_userlist |
List contacts |
wecom-cli todo get_todo_list |
List todos |
wecom-cli todo create_todo |
Create todo |
wecom-cli meeting create_meeting |
Create meeting |
wecom-cli meeting list_user_meetings |
List meetings |
wecom-cli msg get_message |
Get messages |
wecom-cli msg send_message |
Send message |
wecom-cli schedule get_schedule_list_by_range |
List schedules |
wecom-cli schedule create_schedule |
Create schedule |
wecom-cli doc create_doc |
Create document |
wecom-cli doc smartsheet_get_records |
Query smart sheet |
Skills (12 total)
| Skill | Description |
|---|---|
wecomcli-lookup-contact |
Contact search |
wecomcli-get-todo-list |
Todo list query |
wecomcli-get-todo-detail |
Todo details |
wecomcli-edit-todo |
Todo CRUD |
wecomcli-create-meeting |
Create meeting |
wecomcli-edit-meeting |
Cancel/update meeting |
wecomcli-get-meeting |
Query meetings |
wecomcli-get-msg |
Messages & media |
wecomcli-manage-schedule |
Schedule CRUD |
wecomcli-manage-doc |
Document CRUD |
wecomcli-manage-smartsheet-schema |
Smart sheet schema |
wecomcli-manage-smartsheet-data |
Smart sheet records |
Examples
Contact
# Get contact list
wecom-cli contact get_userlist '{}'
Todo
# List todos
wecom-cli todo get_todo_list '{}'
# Create todo
wecom-cli todo create_todo '{"content": "Complete Q2 report", "remind_time": "2026-06-01 09:00:00"}'
# Mark complete
wecom-cli todo update_todo '{"todo_id": "TODO_ID", "todo_status": 0}'
Meeting
# List meetings this week
wecom-cli meeting list_user_meetings '{"begin_datetime": "2026-03-23 00:00", "end_datetime": "2026-03-29 23:59", "limit": 100}'
# Create meeting
wecom-cli meeting create_meeting '{"title": "Tech Review", "meeting_start_datetime": "2026-03-30 15:00", "meeting_duration": 3600, "invitees": {"userid": ["zhangsan", "lisi"]}}'
# Cancel meeting
wecom-cli meeting cancel_meeting '{"meetingid": "MEETING_ID"}'
Messages
# Get chat list
wecom-cli msg get_msg_chat_list '{"begin_time": "2026-03-22 00:00:00", "end_time": "2026-03-29 23:59:59"}'
# Get messages
wecom-cli msg get_message '{"chat_type": 1, "chatid": "zhangsan", "begin_time": "2026-03-29 09:00:00", "end_time": "2026-03-29 18:00:00"}'
# Send message
wecom-cli msg send_message '{"chat_type": 1, "chatid": "zhangsan", "msgtype": "text", "text": {"content": "hello"}}'
Schedule
# List today's schedules
wecom-cli schedule get_schedule_list_by_range '{"start_time": "2026-03-29 00:00:00", "end_time": "2026-03-29 23:59:59"}'
# Create schedule
wecom-cli schedule create_schedule '{"schedule": {"start_time": "2026-03-30 14:00:00", "end_time": "2026-03-30 15:00:00", "summary": "Review", "attendees": [{"userid": "zhangsan"}]}}'
# Check availability
wecom-cli schedule check_availability '{"check_user_list": ["zhangsan", "lisi"], "start_time": "2026-03-30 09:00:00", "end_time": "2026-03-30 18:00:00"}'
Document & Smart Sheet
# Create document
wecom-cli doc create_doc '{"doc_type": 3, "doc_name": "Weekly Report"}'
# Create smart sheet
wecom-cli doc create_doc '{"doc_type": 10, "doc_name": "Task Tracker"}'
# Query smart sheet records
wecom-cli doc smartsheet_get_records '{"docid": "DOC_ID", "sheet_id": "SHEET_ID"}'
# Add record
wecom-cli doc smartsheet_add_records '{"docid": "DOC_ID", "sheet_id": "SHEET_ID", "records": [{"values": {"Title": [{"type": "text", "text": "New Task"}]}}]}'
AI Agent Integration
WeCom CLI works with Claude Code, Codex, Work Buddy, QClaw, and other AI agents.
# Install for AI agent use
npm install -g @wecom/cli
npx skills add WeComTeam/wecom-cli -y -g
# Configure credentials
wecom-cli init
Notes
- Target users: Teams of 10 people or less
- 7 domains: Contact, Todo, Meeting, Messages, Schedule, Docs, Smart Sheets
- 12 Skills: Pre-built skills for AI agent integration
- Credentials: Encrypted storage at
~/.config/wecom/bot.enc - Restart required: After installing skills, restart your AI agent
Comments (0)
Add a Comment
No comments yet. Be the first to comment!