Wecom CLI

https://github.com/wecomteam/wecom-cli
Admin
Wecom CLI is the official command-line interface for WeChat Work, enabling both humans and AI agents...
Tokens:485,415
Snippets:2,651
Trust Score:9
License:MIT
Update:1 month ago
Show doc for...
Tokens:
Raw
### FS setup 临时目录

Source: https://github.com/wecomteam/wecom-cli/blob/main/docs/e2e/CODEGEN.md

使用 tempfile 创建临时目录，用于测试文件系统设置。

```rust
let tmp = tempfile::tempdir().unwrap();
```

--------------------------------

### Install and configure wecom-cli

Source: https://github.com/wecomteam/wecom-cli/blob/main/README.md

Install the CLI globally, add the required CLI Skill, configure credentials interactively (default QR code scan, --manual for manual input), and verify authorization status.

```bash
# 安装 CLI
npm install -g @wecom/cli

# 安装 CLI Skill（必需）
npx skills add WeComTeam/wecom-cli -y -g

# 配置凭证（交互式，仅需一次；默认扫码，--manual 可手动输入）
wecom-cli auth init

# 查看授权状态
wecom-cli auth show
```

--------------------------------

### MID function examples

Source: https://github.com/wecomteam/wecom-cli/blob/main/skills/wecomcli-smartpage/references/formula/text.md

Extracts a substring starting at a specified position for a specified length. Positions start at 1. Examples show extracting from a literal and from a field reference for a birth date.

```plaintext
MID("腾讯文档智能表格",5,4) => "智能表格"
MID([身份证号], 7, 8)    // 提取出生日期
```

--------------------------------

### SEARCH function examples

Source: https://github.com/wecomteam/wecom-cli/blob/main/skills/wecomcli-smartpage/references/formula/text.md

Finds the starting position of a search text within another text, optionally starting from a specified character number. Examples show searching for 'e' in 'Hello' and for a company name in a field.

```plaintext
SEARCH("e","Hello",1) => 2
SEARCH("公司", [公司名称])
```

--------------------------------

### FS setup config.json

Source: https://github.com/wecomteam/wecom-cli/blob/main/docs/e2e/CODEGEN.md

如果需要 config.json，使用 setup_config_json 函数在临时目录中创建配置文件。

```rust
setup_config_json(tmp.path(), &json!({"headers": {"X-Custom": "val"}}));
```

--------------------------------

### 运行 CLI --help 命令

Source: https://github.com/wecomteam/wecom-cli/blob/main/crates/wecom/test-e2e/cases/run/003-help/desc.md

在测试中运行 wecom --help 命令，验证帮助信息输出。需要 wiremock 挂载 discovery mock，因为 --help 会触发 list_services。

```rust
client.run(vec!["wecom", "--help"]).output(output).await
```

--------------------------------

### REPLACE function examples

Source: https://github.com/wecomteam/wecom-cli/blob/main/skills/wecomcli-smartpage/references/formula/text.md

Replaces a portion of text starting at a specified position for a specified length with new text. The new text parameter is optional. Examples show replacing with a literal and masking a phone number.

```plaintext
REPLACE("人面桃花相映红", -5, -1, "梨") =>"人面梨花相映红"
REPLACE([手机号], 4, 4, "****")
```

--------------------------------

### Install @wecom/cli globally

Source: https://github.com/wecomteam/wecom-cli/blob/main/packages/darwin-x64/README.md

Use this command to install the main @wecom/cli package globally, which will automatically install the platform-specific binary as an optional dependency.

```bash
npm install -g @wecom/cli
```

--------------------------------

### Three-phase test framework diagram

Source: https://github.com/wecomteam/wecom-cli/blob/main/docs/e2e/FRAMEWORK.md

ASCII diagram showing the three-phase test framework: Setup (mock server, FsSetup, EnvSetup), Execute (library or process), and Assert (CLI, HTTP, FS).

```text
┌──────────────────────────────────────────────────────────┐
│  Test Function                                           │
│                                                          │
│  1. Setup Phase                                          │
│     ├── Mock server（wiremock / mockito）                │
│     ├── FsSetup（tempdir + config.json + 待上传文件）    │
│     └── EnvSetup（process-level 经 Command::env 注入）   │
│                                                          │
│  2. Execute Phase                                        │
│     ├── Library: client.run(argv).output(buf).await      │
│     └── Process: assert_cmd::Command::cargo_bin("wecom-cli") │
│                                                          │
│  3. Assert Phase                                         │
│     ├── CLI     → result / exit code / stdout / stderr   │
│     ├── HTTP    → mock 命中次数、请求 body / header      │
│     └── FS      → 文件存在、内容、权限                   │
└──────────────────────────────────────────────────────────┘
```

--------------------------------

### TODATE text-to-date conversion examples

Source: https://github.com/wecomteam/wecom-cli/blob/main/skills/wecomcli-smartpage/references/formula/text.md

Converts a text value to a date format. The first example shows the output format as YYYY/MM/DD, while the second example omits the output.

```plaintext
TODATE("2026-5-9")=> 2026/05/09
TODATE("2026-01-01")
```

--------------------------------

### run.rs entry point with include! for test cases

Source: https://github.com/wecomteam/wecom-cli/blob/main/docs/e2e/FRAMEWORK.md

Shows the run.rs entry point structure: it declares the helpers module, imports them, and uses include! to pull in each case's test.rs. This example includes a method_call module that includes the test file for case 001-method-call.

```rust
// crates/wecom/test-e2e/run.rs（节选）
mod helpers;
use helpers::*;

mod run {
    use super::*;
    mod method_call {
        use super::*;
        include!("cases/run/001-method-call/test.rs");
    }
}

```

--------------------------------

### get 请求 JSON 示例

Source: https://github.com/wecomteam/wecom-cli/blob/main/skills/wecomcli-meeting/references/meeting-list.md

用于 meeting get 的请求体，包含 meeting_ids 数组，每个元素可包含 meeting_id 和可选的 sub_meeting_id。

```json
{
  "meeting_ids": [
    { "meeting_id": "<meeting_id_1>" },
    { "meeting_id": "<meeting_id_2>", "sub_meeting_id": "<sub_meeting_id>" }
  ]
}
```

--------------------------------

### wecom-cli smartsheet upload example with sample media_id and docid

Source: https://github.com/wecomteam/wecom-cli/blob/main/skills/wecomcli-smartsheet/references/smart-sheet-record-values.md

Example invocations of the upload commands using placeholder but realistic values. These demonstrate the exact syntax for uploading an image and a non-image file, and they return a URL that is used to populate the corresponding CellValue.

```bash
# 上传图片
wecom-cli smartsheet images upload --json '{"media_id": "mcabc123...", "docid": "a1_xxx"}'

# 上传非图片文件
wecom-cli smartsheet files upload --json '{"media_id": "mcabc123...", "docid": "a1_xxx"}'
```

--------------------------------

### 运行 schema get 命令

Source: https://github.com/wecomteam/wecom-cli/blob/main/crates/wecom/test-e2e/cases/schema/002-get/desc.md

使用 `client.run` 执行 `wecom schema get hr.department.list` 命令，获取指定方法的 schema 信息。

```rust
client.run(vec!["wecom", "schema", "get", "hr.department.list"])
```

--------------------------------

### LOWER function examples

Source: https://github.com/wecomteam/wecom-cli/blob/main/skills/wecomcli-smartpage/references/formula/text.md

Converts all uppercase letters in a text string to lowercase. Examples show converting a literal string and a field reference.

```plaintext
LOWER("SmartSheet") => "smartsheet"
LOWER([城市])
```

--------------------------------

### 调用 `client.run` 并传入 `--output-dir`

Source: https://github.com/wecomteam/wecom-cli/blob/main/crates/wecom/test-e2e/cases/output/002-output-dir-non-download/desc.md

在 Rust 测试中，使用 `client.run` 执行命令，参数包含 `--output-dir` 和临时目录路径。该命令用于验证纯 JSON 响应时不会产生文件。

```rust
client.run(hr_dept_list_argv(&["--output-dir", <tmp_dir>/out]))
```

--------------------------------

### 查看帮助 --help 各级命令

Source: https://github.com/wecomteam/wecom-cli/blob/main/docs/cli-reference.md

获取各级命令的使用方式，包括列出所有命令、指定品类下的工具、指定工具的输入。

```bash
# 列出所有支持的命令和品类
wecom-cli --help

# 列出指定品类下的所有工具
wecom-cli <service> --help

# 列出指定工具所需的输入
wecom-cli <service> [resource...] <method> --help
```

--------------------------------

### Incorrect date format JSON example

Source: https://github.com/wecomteam/wecom-cli/blob/main/skills/wecomcli-smartsheet/references/smart-sheet-field-types.md

Shows an incorrect JSON example where Chinese characters are not wrapped in double quotes, which causes the format to be invalid.

```json
{ "format": "yyyy年m月d日", "auto_fill": false }
```

--------------------------------

### Phone number CellValue example 2

Source: https://github.com/wecomteam/wecom-cli/blob/main/skills/wecomcli-smartsheet/references/smart-sheet-record-values.md

Alternative format for phone numbers, e.g., landline `"0755-12345678"`. Same constraints as example 1.

```json
"0755-12345678"
```

--------------------------------

### 导入doc文档

Source: https://github.com/wecomteam/wecom-cli/blob/main/skills/wecomcli-doc/SKILL.md

将本地的 .doc、.docx 或 .txt 文件导入为企业微信 doc 文档。

```bash
wecom-cli doc import --json '<JSON 参数>'
```
Tokens:
Raw