npm - @sokeai/cli - Versions diffs - 1.0.79 → 1.0.80 - Mend

@sokeai/cli 1.0.79 → 1.0.80

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (128) hide show

package/skills/multi/soke-course/README.md CHANGED Viewed

@@ -1,291 +1,44 @@
-# 授客课程管理 Skill
+# 课程发布主管 · 安装使用教程
-完整的课程生命周期管理，集成素材库和课件管理子 skills，提供模块化的课程内容管理。
+授客AI平台线上课端到端管理技能（自包含单技能，v6.47.0）。
-## 普通用户文档
+## 前提
+- WorkBuddy 桌面端；
+- Node.js ≥ 14；
+- 授客AI平台账号（需有课程管理权限）。
-## 功能概述
+## 安装
-这个 skill 提供了完整的课程管理功能，包括：
+1. 在 WorkBuddy 中安装或更新 `soke-course` 技能；
+2. 手动安装时放入 `~/.workbuddy/skills/soke-course/`。
-- 📚 **课程管理**: 创建、更新、发布、查询课程
-- 🏷️ **分类管理**: 查询和管理课程分类
-- 📦 **素材管理**: 集成 soke-material skill，管理素材库
-- 📝 **课件管理**: 集成 soke-lesson skill，管理课程课件
-- 👥 **学习记录**: 查询用户的课程学习记录
-- 📊 **学习统计**: 查询课件学习记录和人脸识别记录
+## 首次配置（一次性）
-## 集成的子 Skills
+在 WorkBuddy 中说任意触发语（如"帮我创建一门线上课"），技能会自动：
+1. 检测 soke-cli → 未装则按内置 `soke-cli-install-guide.md` 引导（三步：npm prefix → PATH → `npm install -g @sokeai/cli@latest`）；
+2. 检测登录 → 未登录或凭证过期时自动执行 `soke-cli auth login`，调用网页登录授权；授权结束后自动回查登录状态，失败则停止后续写操作。
-### 📦 soke-material - 素材库管理
-负责文件上传和素材管理
-- [详细文档](./references/dependencies/soke-material.md)
+## 三个典型用法
-### 📚 soke-lesson - 课件管理
-负责课件的创建和管理
-- [详细文档](./references/dependencies/soke-lesson.md)
+- 「帮我创建一门新员工入职培训课，分类选企业管理」→ 全流程引导（分类→模板→课件→设置→指派→Gate Check→发布）；
+- 「给这门课加个视频 + 一张封面图」→ 识别为已有课程操作，直接进入课件/封面处理，不再弹出单课或批量模式选择；
+- 「看看谁学完了」→ 未指定课程时先展示已发布线上课前 20 个，支持「搜索 XX」和「下一页」；选定课程后查询学习进度/完成率/作业提交。
-## 快速开始
+## 能力边界（管理预期）
-### 创建课程
+| CLI 可做 | 需后台 |
+|---------|--------|
+| 创建/更新/关闭/发布/定时发布、五类课件、高级设置、指派、进度/人脸/作业查询 | 删除/复制课程、审批/批量发布、新建分类、收费价格/试看、证书/签名、讲师/标签/积分、文章/外链/SCORM/HTML 课件、AI做课 |
-```bash
-# 1. 查询课程分类，获取 category-id
-soke-cli course +list-categories
+## 给学习地图用户
-# 2. 创建课程（使用上一步获取的 category-id）
-soke-cli course +create --title "Go语言入门" --category-id "CATEGORY-UUID"
+本技能内嵌指派能力，但 `soke-learning-map` 技能依赖独立的 soke-assign；如同时使用学习地图，请另行安装 soke-assign。
-# 3. 上传素材
-soke-cli file +upload --file ./lesson1.mp4
+## 反馈
-# 4. 创建课件
-soke-cli course +lesson-create \
-  --course-id "COURSE-UUID" \
-  --title "第一课" \
-  --media-id "MATERIAL-UUID" \
-  --type "video" \
-  --length 600 \
-  --object "path/to/file.mp4" \
-  --filename "lesson1.mp4" \
-  --ext "mp4" \
-  --filesize 10485760
+用出问题请反馈，格式三要素：**场景 + 期望 + 实际**（例：场景"导入试卷建测验"，期望"自动建卷挂载"，实际"第3步填空题报错"）。
-# 5. 发布课程
-soke-cli course +publish --course-id "COURSE-UUID"
-```
+## 变更日志
-### 查询课程
-```bash
-# 查询课程列表
-soke-cli course +list-courses
-# 查询课程详情
-soke-cli course +get-course --course-id "COURSE-UUID"
-# 查询课程分类
-soke-cli course +list-categories
-# 查询课程学习记录
-soke-cli course +list-course-users --course-id "COURSE-UUID"
-```
-## 主要命令
-### 课程管理
-| 命令 | 说明 |
-|------|------|
-| `+list-categories` | 查询课程分类（获取 category-id） |
-| `+create` | 创建课程基本信息 |
-| `+update` | 更新课程信息 |
-| `+delete` | 删除未发布或已关闭课程 |
-| `+advanced` | 更新课程高级设置 |
-| `+publish` | 发布课程 |
-| `+get-course` | 查询课程详情 |
-| `+list-courses` | 查询课程列表 |
-### 课件管理（soke-lesson）
-| 命令 | 说明 |
-|------|------|
-| `+lesson-create` | 创建课件 |
-| `+lesson-get` | 查询课件详情 |
-| `+lesson-list` | 查询课件列表 |
-### 素材管理（soke-material）
-| 命令 | 说明 |
-|------|------|
-| `file +upload` | 上传文件到素材库 |
-| `file +list-files` | 查询素材列表 |
-| `file +get-info` | 查询素材详情 |
-### 学习记录
-| 命令 | 说明 |
-|------|------|
-| `+list-course-users` | 查询课程学习记录 |
-| `+get-course-user` | 查询用户学习详情 |
-| `+list-lesson-learns` | 查询课件学习记录 |
-| `+list-lesson-faces` | 查询人脸识别记录 |
-## 使用场景
-### 场景1: 创建课程
-适用于需要精细控制每个步骤的场景：
-```bash
-# 1. 查询课程分类，获取 category-id
-soke-cli course +list-categories
-# 2. 创建课程（使用上一步获取的 category-id）
-course_id=$(soke-cli course +create \
-  --title "Python数据分析实战" \
-  --category-id "CATEGORY-UUID" \
-  --format json | jq -r '.data.uuid')
-# 3. 批量上传素材
-for file in ./lessons/*.mp4; do
-  media_id=$(soke-cli file +upload --file "$file" --format json | jq -r '.data.uuid')
-  # 4. 创建课件
-  soke-cli course +lesson-create \
-    --course-id "$course_id" \
-    --title "$(basename "$file" .mp4)" \
-    --media-id "$media_id" \
-    --type "video" \
-    --length 600 \
-    --object "path/to/$(basename "$file")" \
-    --filename "$(basename "$file")" \
-    --ext "mp4" \
-    --filesize $(stat -f%z "$file")
-done
-# 5. 发布课程
-soke-cli course +publish --course-id "$course_id"
-# 或定时发布课程，输入北京时间
-soke-cli course +publish \
-  --course-id "$course_id" \
-  --publish-time "2026-07-14 17:24:42"
-```
-### 场景2: 管理现有课程
-```bash
-# 查询课程列表
-soke-cli course +list-courses --status 1
-# 获取课程详情
-soke-cli course +get-course --course-id "COURSE-UUID"
-# 查询课程的课件
-soke-cli course +lesson-list --course-id "COURSE-UUID"
-# 更新课程信息
-soke-cli course +update \
-  --course-id "COURSE-UUID" \
-  --title "新标题" \
-  --description "新描述"
-# 删除未发布或已关闭课程
-soke-cli course +delete --course-id "COURSE-UUID"
-# 添加新课件
-media_id=$(soke-cli file +upload --file ./new-lesson.mp4 --format json | jq -r '.data.uuid')
-soke-cli course +lesson-create \
-  --course-id "COURSE-UUID" \
-  --title "新增课件" \
-  --media-id "$media_id" \
-  --type "video" \
-  --length 600 \
-  --object "path/to/new-lesson.mp4" \
-  --filename "new-lesson.mp4" \
-  --ext "mp4" \
-  --filesize 10485760
-```
-### 场景3: 统计课程完成情况
-```bash
-# 1. 获取课程列表
-soke-cli course +list-courses
-# 2. 查询某个课程的学习记录
-soke-cli course +list-course-users --course-id "COURSE-UUID"
-# 3. 查询课件学习记录
-soke-cli course +list-lesson-learns --lesson-id "LESSON-UUID"
-```
-## 参数说明
-### 时间参数
-所有时间参数使用 Unix 时间戳（毫秒）格式：
-```javascript
-// JavaScript 示例
-const startTime = new Date('2024-01-01').getTime(); // 1704038400000
-const endTime = new Date('2024-12-31').getTime();   // 1735660799000
-```
-### 状态参数
-**课程状态 (status)**:
-- `0`: 未发布
-- `1`: 已发布
-- `2`: 已关闭
-**课程来源 (is-in)**:
-- `0`: 外部课列表
-- `1`: 内部课列表
-**学习模式 (study_type)**:
-- `1`: 自由式（可任意顺序学习）
-- `2`: 解锁式（必须按顺序学习）
-## 注意事项
-1. **课程发布要求**: 课程至少需要一个课件才能发布
-2. **分类必填**: 创建课程时必须指定分类ID
-3. **素材先行**: 创建课件前必须先上传素材到素材库
-4. **类型匹配**: 课件类型必须与素材类型匹配
-5. **权限要求**: 需要相应的读写权限（`course:*:write` 或 `course:*:readonly`）
-6. **认证要求**: 所有命令都需要先完成 `soke-cli auth login`
-## 错误处理
-### 权限不足
-```bash
-# 错误信息: Permission denied
-# 解决方案: 检查是否已登录，并确认账号有相应权限
-soke-cli auth login
-```
-### 时间范围超限
-```bash
-# 错误信息: Time range exceeds 365 days
-# 解决方案: 缩小时间范围或分批查询
-```
-### 数据不存在
-```bash
-# 错误信息: Course not found
-# 解决方案: 检查课程ID是否正确
-```
-## 相关文档
-- [SKILL.md](./SKILL.md) - 完整的 Skill 文档和 API 参考
-- [素材库管理 Skill](./references/dependencies/soke-material.md) - 文件上传和素材管理
-- [课件管理 Skill](./references/dependencies/soke-lesson.md) - 课件创建和管理
-- [共享配置 Skill](./references/shared.md) - 认证和配置管理
-## Skill 架构
-```
-soke-course (主 skill)
-├── 课程管理 (本 skill)
-│   ├── +create (创建课程)
-│   ├── +update (更新课程)
-│   ├── +publish (发布课程)
-│   └── 查询命令...
-├── soke-lesson (子 skill - 课件管理)
-│   ├── +lesson-create
-│   ├── +lesson-get
-│   └── +lesson-list
-└── soke-material (子 skill - 素材管理)
-    ├── file +upload
-    ├── file +create
-    └── 查询命令...
-```
-## 版本历史
-- v3.0.0 (2024-05-26): 重构为模块化架构，集成 soke-material 和 soke-lesson 子 skills
-- v2.0.0 (2024-05-25): 添加课程创建和更新功能
-- v1.0.0 (2024-05-14): 初始版本，支持课程查询、分类、学习记录等功能
+详见同目录 `CHANGELOG.md`。对外分享时可只保留当前版本、兼容性说明和最近重要变更。