wecom-cli - The official open-source command-line tool for WeChat Work

What is wecom-cli?

wecom-cli (WeChat Work CLI) is an open-source command-line tool from the official WeChat Work team, enabling humans and AI agents to operate WeChat Work from the terminal. The tool covers seven core capabilities: contacts, to-do lists, meetings, messages, calendars, documents, and smart spreadsheets, providing 12 out-of-the-box AI Agent Skills and adapting to mainstream AI tools. After installation via npm, developers 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 primarily available to companies with fewer than 10 employees and requires authorization to bind a robot for use.

The main functions of wecom-cli

• Contact Management: Retrieves a list of enterprise members within the current user's visible range, supporting searching for specific users by name or alias.
• To-do listIt supports the creation of pending tasks, list queries, details viewing, content updates, deletion, and changes to user processing status.
• Meeting ManagementIt allows users to create and schedule meetings, cancel meetings, update the list of invited members, and query the meeting list and obtain meeting details.
• Message processingIt can retrieve a list of conversations, pull message records from one-on-one or group chats, download multimedia files from messages, and send text messages to specified users or group chats.
• Schedule ManagementIt supports the creation, modification, and cancellation of schedules, the management of schedule participants, and the query of the availability status of multiple members within a specified time range.
• Document operationsIt can create new documents, read document content (supports Markdown format export), and edit and overwrite document text using Markdown.
• Smart FormsIt supports the creation of intelligent tables, management of sub-table structures and field definitions, and complete data operations such as adding, deleting, modifying, and querying table records.

How to use wecom-cli

• Environmental preparationInstall Node.js and create a WeChat Work long-connection bot to obtain the Bot ID and Secret.
• Installation tools:implement npm install -g @wecom/cli Install CLI, run npx skills add WeComTeam/wecom-cli -y -g Installation required skill.
• Configuration credentials:OK wecom-cli init Perform interactive configuration, encrypt and store robot credentials locally, and only need to be done once.
• Call function:use wecom-cli <品类> <方法> [参数] Format calls, for example wecom-cli contact get_userlist '{}' Retrieve contacts.
• View help:run wecom-cli --help To view all supported commands and categories, or run... wecom-cli <品类> View the list of specific tools under this category.

Key information and usage requirements of wecom-cli

• Basic InformationThis is an official open-source project designed for both humans and AI agents. It supports direct invocation of mainstream AI tools, covers 7 major business categories, and provides 12 out-of-the-box AI Agent Skills.
• environmentNode.js (npm/npx)
• Authorization: The Bot ID and Secret of the robot using the long-connection method need to be bound.
• Enterprise sizeCurrently, priority is given to companies with ≤10 employees.
• Security restrictionsThe bot authorized by the CLI can only be communicated with by its creator; other members cannot use it.

core advantages of wecom-cli

• AI Agent Native DesignIt provides 12 out-of-the-box Skills that can be directly called by mainstream AI tools without the need for additional adaptation and development.
• Full coverage of core capabilitiesIt integrates seven major business domains: address book, to-do list, meetings, messages, calendar, documents, and smart spreadsheets, to meet the needs of enterprises for collaboration across all scenarios.
• Minimalist user experienceIt only takes two steps from installation to the first API call, and you can use it immediately after interactively configuring your credentials.
• Safe and controllableOnce authorized, the robot can only be interacted with by the creator, avoiding the risk of unauthorized access; credentials are encrypted and stored locally to ensure data security.
• Ecological OpennessIt is an official open-source project based on the MIT license, allowing developers to freely extend and customize its functionality.

The project address for wecom-cli

• GitHub repositoryhttps://github.com/WecomTeam/wecom-cli

Comparison of wecom-cli with similar products

Comparison Dimensions	wecom-cli	Tencent QClaw
Product Positioning	Command-line tools in the WeChat Work ecosystem	AI Agent Products Based on OpenClaw
Operation entrance	Terminal command line + AI Agent Skills	WeChat Mini Program "QClaw Butler"
Core Competencies	Contacts, To-Do List, Meetings, Messages, Calendar, Documents, Smart Spreadsheets	WeChat allows for remote computer control, file transfer, and multimodal interaction.
Target users	Developers, AI Agent Builders	Ordinary users and people who need to work remotely
Usage threshold	Requires a Node.js environment and configuration of robot credentials.	No environment configuration required, just scan the code to use.
AI Integration	Provide standardized skills for AI to use.	Built-in "Inspiration Square" with pre-set tasks and skills
Interaction methods	Command line instructions and JSON parameter passing	Natural language dialogue, native WeChat interaction
Deployment method	Local CLI tool, open source and extensible	Cloud service + local client

Application scenarios of wecom-cli