wecom-cli - WeCom's Officially Open-Source Command-Line Tool

What Is wecom-cli

wecom-cli (WeCom CLI) is a command-line tool open-sourced by the official WeCom team, enabling humans and AI Agents to operate WeCom in the terminal. The tool covers 7 core capabilities: Contacts, To-Dos, Meetings, Messages, Calendar, Documents, and Smart Sheets, and provides 12 out-of-the-box AI Agent Skills, compatible with mainstream AI tools. After developers install it via npm, they only need to configure credentials once to call various interfaces, enabling operations such as querying members, creating meetings, sending messages, and managing documents. Currently, the tool is prioritized for enterprises with fewer than 10 people and requires binding a bot for authorized use.

Main Features of wecom-cli

• Contacts Management: Retrieve the list of enterprise members within the current user's visible scope, with support for searching for specific users by name or alias.
• To-Dos: Support creating to-dos, querying lists, viewing details, updating content, deleting, and changing user handling status.
• Meeting Management: Create scheduled meetings, cancel meetings, update the list of invited members, and support querying meeting lists and getting meeting details.
• Message Handling: Retrieve conversation lists, pull message records from one-on-one or group chats, download multimedia files in messages, and send text messages to specified users or group chats.
• Calendar Management: Support creating, modifying, and canceling calendar events, managing event participants, and querying the free/busy status of multiple members within a specified time range.
• Document Operations: Create new documents, read document content (with support for Markdown format export), and edit and overwrite document body text using Markdown.
• Smart Sheets: Support creating smart sheets, managing sub-sheet structures and field definitions, and complete data operations for adding, deleting, modifying, and querying sheet records.

How to Use wecom-cli

• Environment Preparation: Install Node.js, create a WeCom persistent connection bot to obtain the Bot ID and Secret.
• Install the Tool: Execute npm install -g @wecom/cli to install the CLI, run npx skills add WeComTeam/wecom-cli -y -g to install the required Skill.
• Configure Credentials: Run wecom-cli init for interactive configuration, encrypting and storing the bot credentials locally; only needs to be executed once.
• Call Features: Use the wecom-cli <品类> <方法> [参数] format to call, for example wecom-cli contact get_userlist '{}' to get contacts members.
• View Help: Run wecom-cli --help to view all supported commands and categories, or run wecom-cli <品类> to view the specific tool list under that category.

Key Information and Usage Requirements of wecom-cli

• Basic Information: Official open-source project, designed for humans and AI Agents, supports direct calls from mainstream AI tools, covers 7 major business categories, and provides 12 out-of-the-box AI Agent Skills
• Environment：Node.js（npm/npx）
• Authorization: Requires binding the Bot ID and Secret of a persistent connection bot
• Enterprise Size: Currently prioritized for enterprises with ≤10 people
• Security Restrictions: Only the creator of the bot authorized for the CLI can converse with it; other members cannot use it

Core Advantages of wecom-cli

• AI Agent Native Design: Provides 12 out-of-the-box Skills that mainstream AI tools can call directly, with no additional adaptation development required.
• Full Coverage of Core Capabilities: Integrates 7 major business domains—contacts, to-dos, meetings, messages, schedules, documents, and smart sheets—meeting the full range of enterprise collaboration needs.
• Minimalist User Experience: From installation to the first API call takes only two steps; after interactive credential configuration, it is ready to use immediately.
• Secure and Controllable: After the bot is authorized, only the creator can converse with it, avoiding the risk of unauthorized access; credentials are encrypted and stored locally to ensure data security.
• Open Ecosystem: An official open-source project under the MIT License, allowing developers to freely extend and customize functionality.

Project address of wecom-cli

• GitHub Repository：https://github.com/WecomTeam/wecom-cli

Comparison of wecom-cli with similar competing products

Comparison Dimension	wecom-cli	Tencent QClaw
Product Positioning	Command-line tool for the WeCom ecosystem	AI Agent product based on OpenClaw
Operation Entry Point	Terminal command line + AI Agent Skills	WeChat Mini Program "QClaw Manager"
Core Capabilities	Contacts, to-dos, meetings, messages, schedules, documents, smart sheets	Remote computer control via WeChat, file transfer, multimodal interaction
Target Users	Developers, AI Agent builders	Ordinary users, people who need remote work
Usage Barrier	Requires a Node.js environment and bot credential configuration	No environment configuration required; ready to use after scanning a QR code
AI Integration	Provides standardized Skills for AI to call	Built-in "Inspiration Plaza" with preset tasks and Skills
Interaction Method	Command-line instructions, JSON parameter passing	Natural language conversation, native WeChat interaction
Deployment Method	Local CLI tool, open source and extensible	Cloud service + local client

Application scenarios of wecom-cli