安装与配置
@yuyuecha/cli 是愉悦查提供的企业级命令行接入工具，适合 IT 团队将批量背调 / 风险核查能力集成到现有工作流。支持 macOS / Linux / Windows（WSL2），Node.js 18+ 运行时。
系统要求
安装
Shell
# 全局安装（推荐） $ npm install -g @yuyuecha/cli # 验证安装成功 $ yyc --version ✓ @yuyuecha/cli 1.0.0 # 查看所有命令 $ yyc --help
初始化配置
首次使用运行 yyc init 完成 API Key 绑定。交互式引导完成后，配置文件保存在 ~/.yyc/config.json（加密存储）。
Shell · yyc init
$ yyc init ? 请输入您的 API Key: yyc_xxxxxxxxxxxxxxxx ? 默认产品（空格多选，回车确认）: ◉ 入职背调 (backgroundcheck) ◉ 家政风险 (homeservice) ○ 婚恋风险 (marriage) ○ 个人大数据 (riskassessment) ? 报告输出目录: ./yyc-reports ? 并发数量: 3 ✓ API Key 已通过验证 ✓ 配置文件已加密写入 ~/.yyc/config.json ✓ 配置完成，可开始使用 yyc query / yyc batch
✓
API Key 以 AES-256-GCM 加密存储在本地，不会上传到任何云端服务。更换 Key 重新运行
yyc init 即可。5 分钟快速上手
1
INSTALL
安装 CLI
npm install -g @yuyuecha/cli，然后 yyc --version 验证安装。
2
CONFIG
初始化配置
yyc init 绑定 API Key，选择默认产品，设置报告输出目录。
3
QUERY
发起查询
yyc query 单条测试，确认无误后 yyc batch 批量处理名单。
yyc query — 单条查询
Shell · yyc query
$ yyc query \ --product backgroundcheck \ --name "张三" \ --id "110101****1234" \ --phone "138****0000" \ --consent # 启用企业统一授权模式 ✓ 授权已确认（企业统一授权协议） ✓ 订单创建 · ID: ord_abc123 查询中… (预计 8-12s) ✓ 报告完成 → ./yyc-reports/backgroundcheck_张三_20260517.pdf
yyc batch — 批量查询
Shell · yyc batch
$ yyc batch \ --file ./candidates.csv \ --product backgroundcheck \ --output ./reports/ \ --format pdf \ --concurrency 3 # 最大并发数（1-5，默认 3） ✓ 1/24 张三 completed 8.2s ✓ 2/24 李四 completed 11.4s ✗ 3/24 王五 CONSENT_MISSING → 跳过，见 error.log ✓ 4/24 赵六 completed 9.8s ... ✓ 完成 23/24 · 1 条失败 · 导出至 ./reports/ 查看失败详情: ./reports/error.log
CSV 格式要求
CSV 示例文件
CSV · candidates.csv
name,id_number,phone,product,remark 张三,110101****1234,138****0000,backgroundcheck,2026 届校招 李四,310101****5678,139****0001,backgroundcheck,社招候选人 王五,440101****9012,,homeservice,家政小时工
⚠
批量查询须确保每位被查询人已签署知情同意书（纸质或电子均可）。
--consent 参数为企业统一授权模式，使用前须已签署《数据查询授权协议》。违规查询将导致 API Key 永久封禁，并承担相应法律责任。yyc status — 查询订单状态
Shell · yyc status
$ yyc status --order-id ord_abc123 状态: completed 产品: 入职背调 被查人: 张** 完成时间: 2026-05-17 14:32:18 报告路径: ./yyc-reports/backgroundcheck_张三_20260517.pdf
yyc export — 重新导出报告
Shell · yyc export
# 以不同格式重新导出 $ yyc export \ --order-id ord_abc123 \ --format json \ --output ./exports/ ✓ 导出完成 → ./exports/ord_abc123.json
yyc config — 查看/修改配置
Shell · yyc config
# 查看当前配置（API Key 脱敏显示） $ yyc config --show api_key: yyc_xxxx****xxxx products: backgroundcheck, homeservice output: ./yyc-reports concurrency: 3 env: production # 切换到测试环境 $ yyc config --env test # 重置配置 $ yyc config --reset
CI/CD 集成
在 CI/CD 环境中，通过环境变量传入 API Key，避免硬编码到配置文件或代码仓库。
GitHub Actions · .github/workflows/bgcheck.yml
name: Background Check on: workflow_dispatch: inputs: csv_file: description: '候选人名单 CSV' required: true jobs: check: runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 - name: Install CLI run: npm install -g @yuyuecha/cli - name: Run batch check env: YYC_API_KEY: ${{ secrets.YYC_API_KEY }} run: | yyc batch \ --file "${{ github.event.inputs.csv_file }}" \ --product backgroundcheck \ --output ./reports/ \ --consent - uses: actions/upload-artifact@v4 with: name: background-check-reports path: ./reports/
ℹ
在 CI/CD 中设置
YYC_API_KEY 环境变量后，CLI 自动读取，无需运行 yyc init。同时建议在 CI Runner 所在网络配置 IP 白名单，联系商务申请固定 IP 访问权限。合规要点
⚠
使用 CLI 进行查询前，必须满足以下合规要求：
1. 企业已签署《愉悦查数据查询服务协议》及《数据处理授权协议》
2. 每位被查询人已签署知情同意书（纸质或电子版均可）
3. 查询目的合法合规，不得用于非授权场景
4. 查询结果只用于内部决策，不得转售或外泄
1. 企业已签署《愉悦查数据查询服务协议》及《数据处理授权协议》
2. 每位被查询人已签署知情同意书（纸质或电子版均可）
3. 查询目的合法合规，不得用于非授权场景
4. 查询结果只用于内部决策，不得转售或外泄
数据留存要求
← 上一页
MCP Server 文档
下一页 →
Agent 产品总览