@sokeai/cli 1.0.76 → 1.0.78

package/skills/multi/soke-learning-map/references/dependencies/soke-task.md

@@ -0,0 +1,146 @@
+---
+name: soke-task
+summary: 授客学堂异步任务管理（创建统计任务/查询任务状态/获取报表文件），支持学习地图和课程学员统计的报表导出与统计生成，通过 soke-cli 操作
+version: 1.1.0
+description: "授客学堂异步任务管理：通过 soke-cli task 创建统计任务、查询任务状态、获取导出文件。支持学习地图学员统计和课程学员统计的报表导出与统计生成。当用户需要生成学习地图或课程学员统计报表、生成统计、查询任务状态或获取文件下载地址时使用。"
+metadata:
+  requires:
+    bins: ["soke-cli"]
+  cliHelp: "soke-cli task --help"
+---
+
+# 异步任务管理 (soke-task)
+
+**CRITICAL — 开始前 MUST 先读取 [`../shared.md`](../shared.md)，其中包含认证、配置和权限处理。**
+
+## 核心规则
+
+- 任务接口是独立模块，命令统一使用 `soke-cli task ...`，不要使用 `soke-cli learning-map ...` 创建或查询任务。
+- 创建任务后必须保存返回的 `data.id`，再调用 `+get` 查询任务详情。
+- 默认用 `--format json` 获取结构化输出；需要人工快速查看时可省略 format 输出表格。
+- 当前已知任务类型是学习地图学员统计和课程学员统计；`--module` 默认 `learningMapUser`，课程学员统计使用 `--module courseUser`。
+- `--target-id` 是统一目标 ID：`--module learningMapUser` 时会提交为 `学习地图id`，`--module courseUser` 时会提交为 `课程id`。
+- `--departments` 和 `--users` 可传英文逗号分隔 ID 或 JSON 数组；CLI 会转换为接口需要的对象数组。
+- `--action` 默认 `export`，`--type` 默认 `aloneDept`。
+- 查询 `soke-cli task +get --id "TASK-ID"` 后，必须根据创建任务时传入的 `--action` 判断状态字段：`action=export` 看 `data.export_status`，`action=report` 看 `data.status`。
+
+## 命令
+
+### 创建学习地图学员统计任务
+
+```bash
+soke-cli task +create \
+  --target-id "MAP-UUID" \
+  --learn-type "required" \
+  --type "aloneDept" \
+  --departments "130110584" \
+  --users "1302105847786" \
+  --custom-tags "job_number,position" \
+  --limit 4500 \
+  --format json
+```
+
+### 创建课程学员统计任务
+
+```bash
+soke-cli task +create \
+  --target-id "COURSE-UUID" \
+  --module courseUser \
+  --learn-type "required" \
+  --type "aloneDept" \
+  --departments '[130110584]' \
+  --users '[1302105847786]' \
+  --limit 4500 \
+  --format json
+```
+
+完整参数：
+
+| 参数 | 必填 | 默认值 | 说明 |
+|------|------|--------|------|
+| `--target-id` | 是 | - | 目标 UUID；`learningMapUser` 时作为 `map_id`，`courseUser` 时作为 `course_id` |
+| `--module` | 否 | `learningMapUser` | 任务模块：`learningMapUser` 学习地图学员统计，`courseUser` 课程学员统计 |
+| `--learn-type` | 否 | `required` | 学习类型，如 `required` |
+| `--learn-status` | 否 | 空 | 学习状态筛选：空值表示不限，`learning` 未完成，`finished` 已完成 |
+| `--eligible-status` | 否 | 空 | 达标状态筛选，空值表示不限 |
+| `--limit` | 否 | `4500` | 任务处理上限 |
+| `--action` | 否 | `export` | 操作类型：`export` 生成报表，`report` 生成统计 |
+| `--type` | 否 | `aloneDept` | 部门导出类型：`aloneDept` 单列导出，`manyDept` 部门多列导出 |
+| `--is-leave` | 否 | `0` | 是否离职：`0` 否，`1` 是 |
+| `--taskId` | 否 | 空字符串 | 任务 ID，默认空字符串 |
+| `--departments` | 否 | 空 | 部门 ID 列表，多个 ID 用英文逗号分隔；也可传 JSON 数组 |
+| `--users` | 否 | 空 | 用户 ID 列表，多个 ID 用英文逗号分隔；也可传 JSON 数组 |
+| `--custom-tags` | 否 | 空 | 导出的自定义字段列表，多个字段用英文逗号分隔；也可传 JSON 字符串数组 |
+
+响应关键字段：
+
+| 字段 | 说明 |
+|------|------|
+| `data.id` | 任务 ID，查询任务详情时传给 `+get --id` |
+| `data.key` | 任务去重或配置缓存 Key |
+| `data.config_result` | 上游配置模块检查结果 |
+
+默认输出会打印单行任务 ID，例如 `id:13288419`。需要完整字段时使用 `--format json`。
+
+### 查询异步任务
+
+```bash
+soke-cli task +get --id "TASK-ID" --format json
+```
+
+状态判断规则：
+
+| 创建任务时的 `--action` | 查询完成状态字段 | 说明 |
+|-------------------------|------------------|------|
+| `export` | `data.export_status` | 生成报表时用导出状态判断是否生成文件 |
+| `report` | `data.status` | 生成统计时用任务执行状态判断是否完成 |
+
+响应关键字段：
+
+| 字段 | 说明 |
+|------|------|
+| `data.status` | 任务执行状态；`action=report` 生成统计时用此字段判断任务状态，接口示例中 `2` 表示执行完成 |
+| `data.export_status` | 导出状态；`action=export` 生成报表时用此字段判断导出状态，接口示例中 `2` 表示已生成导出文件 |
+| `data.filePath` | 导出文件访问地址，未生成时为空 |
+| `data.filename` | 导出文件名 |
+| `data.filesize` | 导出文件大小 |
+| `data.params` | 创建任务参数的 JSON 字符串 |
+
+## 推荐工作流
+
+```bash
+TASK_ID=$(soke-cli task +create \
+  --target-id "$MAP_UUID" \
+  --learn-type "required" \
+  --type "aloneDept" \
+  --custom-tags "工号,岗位,入职日期" \
+  --limit 4500 \
+  --format json | jq -r '.data.id')
+
+soke-cli task +get --id "$TASK_ID" --format json | jq -r '.data.filePath'
+```
+
+按创建任务的 action 查询状态：
+
+```bash
+# action=export
+soke-cli task +get --id "$TASK_ID" --format json | jq -r '.data.export_status'
+
+# action=report
+soke-cli task +get --id "$TASK_ID" --format json | jq -r '.data.status'
+```
+
+## API 接口映射
+
+| CLI 命令 | API 路径 | 方法 |
+|----------|----------|------|
+| `task +create` | `/skills/job/task` | POST (form) |
+| `task +get` | `/skills/job/task/{id}` | GET |
+
+## 排错
+
+- `data.filePath` 为空：任务可能还未完成，等待后重新执行 `task +get --id "TASK-ID" --format json`。
+- `未登录授权`：按 `soke-shared` 执行 `soke-cli auth login` 后重试。
+- 自定义字段没有导出：确认已通过 `--custom-tags "字段1,字段2"` 指定，字段名需与当前任务类型支持的自定义字段一致。
+- 任务创建失败：确认 `--target-id` 与 `--module` 匹配；学习地图用 `--module learningMapUser`，课程用 `--module courseUser`。
+- 部门或用户筛选无效：先用 `soke-cli assign +list-departments` / `soke-cli assign +list-users` 确认可用 ID，再传给 `--departments` / `--users`。

package/skills/multi/soke-learning-map/references/installation.md

@@ -0,0 +1,451 @@
+# 授客CLI 工具 - 快速上手指南
+
+本文档将指导你从零开始安装 `soke-cli`，完成用户登录授权，并开始使用授客AI开放平台的各项功能。
+
+---
+
+## 📋 目录
+
+- [前置要求](#前置要求)
+- [安装步骤](#安装步骤)
+- [用户登录授权](#用户登录授权)
+- [验证安装](#验证安装)
+- [常见问题](#常见问题)
+- [下一步](#下一步)
+
+---
+
+## 前置要求
+
+在开始之前，请确保你的系统满足以下要求：
+
+### 必需条件
+- **Node.js**: 版本 >= 14.0.0（用于 NPM 安装）
+- **网络连接**: 能够访问授客AI开放平台 API（默认：`https://opendev.soke.cn`）
+- **浏览器**: 用于完成 OAuth 授权流程
+
+> 💡 **提示**: 使用 `soke-cli` 无需预先配置任何凭证，所有配置将在登录授权过程中自动完成。
+
+---
+
+## 安装步骤
+
+> ⚠️ **先看这里**：以下步骤会将 `soke-cli` 安装到用户专属目录（`~/.npm-global`），无需 sudo、不依赖任何 AI 工具，任何终端打开即用。
+> 
+> **三步走：① 改 npm prefix → ② 加 PATH → ③ 安装**
+
+### 第一步：配置 npm prefix（所有平台通用）
+
+设置 npm 全局安装路径为用户专属目录，这样：
+- **不需要 sudo/管理员权限**
+- **不会装到奇怪的系统目录**
+- **任何终端都能找到**
+
+```bash
+mkdir -p ~/.npm-global
+npm config set prefix ~/.npm-global
+```
+
+> 💡 这一步只需执行一次，之后所有通过 `npm install -g` 安装的工具都会放到统一位置。
+
+---
+
+### 第二步：把 npm 全局 bin 目录加入 PATH
+
+把 `~/.npm-global/bin` 加入 shell 搜索路径，这样终端才能找到 `soke-cli`。
+
+#### macOS / Linux
+
+在 `~/.zshrc`（Zsh）或 `~/.bashrc`（Bash）末尾追加一行：
+
+```bash
+echo 'export PATH="$HOME/.npm-global/bin:$PATH"' >> ~/.zshrc
+source ~/.zshrc
+```
+
+> 💡 **Apple Silicon (M1/M2/M3) 用户**如果用 Homebrew 安装 Node.js，npm prefix 可能已指向 `/opt/homebrew`（arm64）或 `/usr/local`（x64）。上述 `npm config set prefix` 会覆盖默认值，所有全局工具统一走 `~/.npm-global`，不影响 Homebrew 自有工具。
+
+#### Windows
+
+**PowerShell**：
+```powershell
+# 查看当前用户 PATH
+[Environment]::GetEnvironmentVariable('Path', 'User')
+
+# 追加 npm-global 路径
+$npmGlobal = "$env:USERPROFILE\.npm-global\bin"
+[Environment]::SetEnvironmentVariable('Path', "$(([Environment]::GetEnvironmentVariable('Path', 'User') -split ';' -notlike '' -join ';'));$npmGlobal", 'User')
+
+# 验证（需要重新打开 PowerShell 使改动生效，或手动刷新）
+$env:Path = [Environment]::GetEnvironmentVariable('Path', 'User')
+```
+
+**CMD**：
+```cmd
+setx PATH "%PATH%;%USERPROFILE%\.npm-global\bin"
+```
+
+> ⚠️ **Windows**: `setx` 修改的是**系统环境变量**，需要新的 CMD/PowerShell 窗口才能生效（当前窗口不会变）。
+
+---
+
+### 第三步：安装 soke-cli
+
+PATH 配置完成后，新开一个终端窗口（或 `source` 刚改的文件），然后安装：
+
+**macOS / Linux**：
+```bash
+npm install -g @sokeai/cli@latest
+```
+
+**Windows (PowerShell / CMD)**：
+```powershell
+npm install -g @sokeai/cli@latest
+```
+
+> 💡 安装脚本会自动根据操作系统（macOS / Linux / Windows）和芯片架构（x64 / arm64）下载对应二进制文件，无需手动选择。
+
+---
+
+### 安装后验证
+
+新开一个终端（让 PATH 生效），依次执行：
+
+```bash
+# 确认路径
+which soke-cli
+# 预期输出类似: /Users/你的用户名/.npm-global/bin/soke-cli
+
+# 确认版本
+soke-cli --version
+# 预期输出: soke-cli version x.x.x
+```
+
+如果显示版本号，说明基础安装成功。完成后续登录授权后，请继续运行 `soke-cli doctor` 做完整健康检查，确保配置、登录态、日志目录和网络连通性都可用。
+
+**如果 `which soke-cli` 无输出**，说明 PATH 未生效：
+- macOS/Linux: 确认 `echo $PATH | tr ':' '\n' | grep npm-global` 有输出，若没有请重新执行第二步
+- Windows: 确认环境变量中已添加 `C:\Users\你的用户名\.npm-global\bin`
+
+---
+
+## 用户登录授权
+
+安装完成后，直接执行登录命令即可开始使用。无需预先配置，所有必要的配置信息将在授权过程中自动获取并保存。
+
+### OAuth 浏览器授权流程
+
+`soke-cli` 使用 OAuth 2.0 授权码流程（Authorization Code Flow），通过浏览器完成安全授权。
+
+### 执行登录命令
+
+```bash
+soke-cli auth login
+```
+
+### 授权步骤
+
+1. **自动打开浏览器**
+   
+   命令执行后，会自动在默认浏览器中打开授权页面。如果浏览器没有自动打开，会显示授权链接：
+   ```
+   ℹ️  未找到登录信息，开始授权流程
+   
+   请在浏览器中打开以下链接进行授权:
+   http://127.0.0.1:8080/callback?redirect_uri=...
+   
+   等待授权中...
+   ```
+
+2. **浏览器授权**
+   
+   在浏览器授权页面中：
+   - 如果未登录授客AI平台，先完成登录
+   - 查看应用请求的权限列表
+   - 勾选"一并开通审批的常用权限"（可选）
+   - 点击"开通并授权"按钮
+
+3. **授权成功**
+   
+   授权完成后，浏览器会显示成功页面，CLI 终端会显示：
+   ```
+   ✅ 已登录，Token 仍然有效
+   企业 ID: corp_123456
+   ```
+
+4. **配置自动保存**
+   
+   授权成功后，以下信息会自动保存到 `~/.soke-cli/config.json`：
+   - 用户访问令牌（`user_token`）
+   - 企业 ID（`corpid`）
+   - 部门用户 ID（`dept_user_id`）
+   - Token 过期时间
+
+### Token 有效期
+
+- **访问令牌（Access Token）**: 默认有效期根据平台设置，通常为数小时到数天
+- **自动检查**: 每次执行命令时，CLI 会自动检查 Token 是否有效
+- **自动续期**: Token 过期后，再次执行 `soke-cli auth login` 即可重新授权
+
+### 强制重新登录
+
+如果需要切换账号或强制重新授权，可以使用 `--force` 参数：
+
+```bash
+soke-cli auth login --force
+```
+
+### 退出登录
+
+如果需要退出登录，清除本地保存的令牌：
+
+```bash
+soke-cli auth logout
+```
+
+输出：
+```
+✓ 已退出登录
+```
+
+---
+
+## 验证安装
+
+完成登录授权后，让我们验证一切是否正常工作。推荐先运行 `doctor`，它会一次性检查 CLI 版本、配置文件、登录态、日志目录和网络连通性。
+
+### 1. 运行健康检查
+
+```bash
+soke-cli doctor
+```
+
+正常情况下会看到类似输出：
+```text
+pass    cli_version     x.x.x
+pass    config          /Users/你的用户名/.soke-cli/config.json
+pass    auth            login data looks valid locally
+pass    logs            /Users/你的用户名/.soke-cli/logs
+pass    network         https://opendev.soke.cn reachable (123ms)
+```
+
+如果任意检查项显示 `fail`，请根据同一行或下一行的 `hint` 提示处理。常见情况：
+- `config` 或 `auth` 失败：重新执行 `soke-cli auth login`
+- `logs` 失败：检查 `~/.soke-cli` 或 `SOKE_CLI_LOG_DIR` 的写入权限
+- `network` 失败：检查网络连接或代理设置
+
+需要机器可读输出时，可以使用 JSON 格式：
+
+```bash
+soke-cli doctor --format json
+```
+
+如果当前环境不能访问外网，只想检查本地安装、配置、登录态和日志目录，可以跳过网络检查：
+
+```bash
+soke-cli doctor --offline
+```
+
+网络较慢时可以调大超时时间：
+
+```bash
+soke-cli doctor --timeout 30
+```
+
+### 2. 查看配置信息
+
+```bash
+soke-cli config show
+```
+
+确认配置信息已自动保存：
+```
+当前配置:
+  app_key: (未设置)
+  app_secret: (未设置)
+  api_base_url: 
+  corpid: corp_123456
+  用户ID: user_789012
+  用户凭证: eyJh...xyz
+  token过期时间: 2026-10-17 12:00:00
+```
+
+> 💡 **说明**: `app_key` 和 `app_secret` 在当前版本中不需要手动配置，授权流程会自动处理所有必要的认证信息。如果 `doctor` 已全部通过，这一步主要用于人工确认当前登录的企业和用户信息。
+
+### 3. 测试 API 调用
+
+尝试调用一个简单的 API：
+
+```bash
+soke-cli api GET /users/me
+```
+
+如果返回你的用户信息（JSON 格式），说明一切配置正确！
+
+### 4. 使用业务命令
+
+尝试使用一个业务快捷命令，例如查看考试列表：
+
+```bash
+soke-cli exam +list-exams --page 1 --page-size 10
+```
+
+---
+
+## 常见问题
+
+### Q1: 安装时提示 "网络连接失败"
+
+**原因**: 无法从 GitHub Releases 下载二进制文件。
+
+**解决方案**:
+1. 检查网络连接
+2. 如果在国内，可能需要配置代理
+3. 尝试重新安装：`npm install -g @sokeai/cli`
+
+### Q2: 执行 `soke-cli` 提示 "command not found" 或 "不是内部或外部命令"
+
+**原因**: 二进制文件不在系统 PATH 中。
+
+**解决方案（重新做安装步骤第二步）**:
+
+**macOS / Linux**：
+```bash
+# 确认 npm-global/bin 是否已在 PATH
+which soke-cli
+
+# 若无输出，检查路径是否存在
+ls ~/.npm-global/bin/soke-cli 2>/dev/null && echo "存在，但 PATH 未生效"
+
+# 重新追加 PATH 并生效
+echo 'export PATH="$HOME/.npm-global/bin:$PATH"' >> ~/.zshrc
+source ~/.zshrc
+
+# 再次验证
+which soke-cli
+soke-cli --version
+```
+
+**Windows**：
+```powershell
+# 检查 .npm-global/bin 是否存在
+Test-Path "$env:USERPROFILE\.npm-global\bin\soke-cli.exe"
+
+# 若存在但命令找不到，手动刷新 PATH
+$env:Path = [Environment]::GetEnvironmentVariable('Path', 'User')
+
+# 确认
+where.exe soke-cli
+```
+
+**直接运行（临时方案，不推荐长期使用）**：
+
+**macOS / Linux**：
+```bash
+~/.npm-global/bin/soke-cli --version
+```
+
+**Windows**：
+```cmd
+%USERPROFILE%\.npm-global\bin\soke-cli.exe --version
+```
+
+### Q3: 登录时浏览器没有自动打开
+
+**原因**: 系统无法自动打开默认浏览器。
+
+**解决方案**:
+1. 复制终端显示的授权链接
+2. 手动在浏览器中打开该链接
+3. 完成授权流程
+
+### Q4: 浏览器授权后，CLI 仍显示 "等待授权中..."
+
+**原因**: 
+- 浏览器授权未成功完成
+- 本地回调服务器端口被占用
+- 网络连接问题
+
+**解决方案**:
+1. 确认浏览器页面显示"授权成功"
+2. 检查防火墙是否阻止了本地端口（127.0.0.1）
+3. 按 `Ctrl+C` 取消，重新执行 `soke-cli auth login`
+
+### Q5: API 调用返回 "401 Unauthorized"
+
+**原因**: Token 已过期或无效。
+
+**解决方案**:
+```bash
+# 重新登录
+soke-cli auth logout
+soke-cli auth login
+```
+
+### Q6: 如何在 AI Agent 中使用？
+
+**解决方案**:
+
+安装 AI Agent Skills：
+```bash
+npx skills add liuchenlong1111/soke-cli -y -g
+```
+
+然后在 AI Agent（如 Claude Code）中直接用自然语言：
+- "查询考试成绩"
+- "列出最近的考试"
+
+AI 会自动调用相应的 `soke-cli` 命令。
+
+---
+
+## 下一步
+
+恭喜！你已经成功安装并配置了 `soke-cli`。接下来你可以：
+
+### 📚 学习更多命令
+
+查看所有可用命令：
+```bash
+soke-cli --help
+```
+
+查看特定模块的命令：
+```bash
+soke-cli course --help
+soke-cli exam --help
+soke-cli contact --help
+```
+
+### 🚀 使用业务功能
+
+- **课程管理**: `soke-cli course +list-courses`
+- **考试管理**: `soke-cli exam +list-exams`
+- **通讯录**: `soke-cli contact +list-users`
+- **学习地图**: `soke-cli learning-map +list-maps`
+
+### 🤖 安装 AI Agent Skills（推荐）
+
+```bash
+npx skills add liuchenlong1111/soke-cli -y -g
+```
+
+安装后，在 AI Agent 中可以用自然语言操作授客AI平台，无需记忆复杂命令。
+
+### 📖 阅读详细文档
+
+
+---
+
+## 获取帮助
+
+如果遇到问题：
+
+1. **查看帮助文档**: `soke-cli --help`
+2. **查看配置**: `soke-cli config show`
+3. **访问开放平台**: https://opendev.soke.cn
+4. **提交 Issue**: https://github.com/liuchenlong1111/soke-cli/issues
+
+---
+
+**祝你使用愉快！** 🎉