@sokeai/cli 1.0.0

package/README.md

@@ -0,0 +1,100 @@
+# 授客AI官方CLI工具 (soke-cli)
+
+`soke-cli` 是授客AI官方提供的命令行工具，旨在帮助开发者和系统管理员更便捷地通过命令行与授客AI开放平台进行交互。该工具使用 Go 语言开发，支持多平台，并提供了 NPM 包的安装方式。
+
+## 核心能力
+
+`soke-cli` 提供了以下核心能力：
+
+1. **认证与配置管理**
+   - 支持通过 OAuth 设备码授权流程（Device Flow）进行快速登录。
+   - 灵活的配置管理，支持多租户、多环境（AppKey, AppSecret, API地址, CorpID等）。
+
+2. **通用 API 调用**
+   - 提供 `api` 基础命令，支持直接发起任意 GET、POST、PUT、DELETE 等 HTTP 请求到开放平台接口。
+
+3. **业务模块快捷命令**
+   - 针对授客AI核心业务场景提供了丰富的快捷命令集：
+     - **通讯录 (contact)**: 部门与用户查询、管理等。
+     - **课程 (course)**: 课程列表、分类、学习记录、人脸识别记录等。
+     - **考试 (exam)**: 考试列表、分类、考试成绩与记录查询。
+     - **学习地图 (learning-map)**: 学习地图、阶段、任务查询与分配。
+     - **证书 (certificate)**: 证书发放记录、分类等。
+     - **学分 (credit) & 积分 (point)**: 学分/积分日志及用户情况查询。
+     - **培训 (training)**: 线下培训查询与分配。
+     - **新闻公告 (news)**: 资讯列表与详情。
+
+## 安装方法
+
+### 方式一：通过 NPM 安装 (推荐)
+如果你本地已安装 Node.js，可以直接使用 npm 全局安装：
+```bash
+npm install -g @sokeai/cli
+```
+
+### 方式二：通过源码编译安装 (需要 Go 环境)
+```bash
+# 1. 克隆/下载本仓库代码
+git clone <repository_url>
+cd soke-cli
+
+# 2. 编译并安装到 /usr/local/bin
+make install
+```
+
+## 快速开始
+
+### 1. 初始化配置
+首次使用前，需要配置你的开放平台凭证：
+```bash
+soke-cli config init
+```
+根据提示输入 `app_key`, `app_secret`, API地址(默认: `https://opendev.soke.cn`), `corpid` 和 `dept_user_id`。
+
+可以使用 `soke-cli config show` 来查看当前配置。
+
+### 2. 用户登录授权
+配置完成后，进行设备授权登录：
+```bash
+soke-cli auth login
+```
+命令会返回一个设备码和链接，请在浏览器中打开链接并输入设备码完成授权。成功后即可调用需要用户授权的接口。
+如果需要退出登录，可以执行 `soke-cli auth logout`。
+
+## 使用示例
+
+### 调用快捷业务命令
+以课程模块为例，你可以使用以下命令获取课程列表：
+```bash
+# 查看 course 模块的帮助和可用命令
+soke-cli course --help
+
+# 获取课程列表 (使用必要的参数)
+soke-cli course +list-courses --start-time 1672502400000 --end-time 1704038400000 --page 1 --page-size 10
+```
+
+### 使用通用 API 命令
+如果你需要调用的接口尚未包含在快捷命令中，可以直接使用 `api` 命令：
+```bash
+# 发起 GET 请求
+soke-cli api GET /users/me
+
+# 发起 POST 请求，携带 JSON 参数
+soke-cli api POST /some/endpoint --data '{"key": "value"}'
+```
+
+## 项目结构说明
+
+- `cmd/`: 存放所有 CLI 子命令的定义（按业务模块划分，如 `auth`, `course`, `exam` 等）。
+- `internal/`: 存放核心逻辑，包括认证 (`auth`)、API 客户端封装 (`client`)、配置管理 (`core`) 以及输出格式化 (`output`) 等。
+- `shortcuts/`: 定义了各个业务模块的快捷命令元数据（API路径、参数、默认值等），供 `cmd/` 动态注册命令使用。
+- `scripts/`: NPM 包相关的安装与运行脚本。
+- `main.go`: CLI 的主入口文件。
+
+## 开发与贡献
+
+1. 依赖管理：项目使用 Go Modules，可以运行 `go mod tidy` 整理依赖。
+2. 添加新命令：
+   - 业务接口建议在 `shortcuts/` 目录下添加对应的结构定义。
+   - 基础功能可在 `cmd/` 下新建对应包并在 `cmd/root.go` 中注册。
+3. 测试：运行 `make test` 进行单元测试。

package/package.json

@@ -0,0 +1,32 @@
+{
+    "name": "@sokeai/cli",
+    "version": "1.0.0",
+    "description": "授客AI官方CLI工具",
+    "bin": {
+        "soke-cli": "scripts/run.js"
+    },
+    "scripts": {
+        "postinstall": "node scripts/install.js",
+        "build": "./scripts/build-binaries.sh",
+        "release": "./scripts/release.sh"
+    },
+    "files": [
+        "scripts/"
+    ],
+    "repository": {
+        "type": "git",
+        "url": "https://codeup.aliyun.com/5edbc121d1d1abe63b55f1c7/soke/soke-cli.git"
+    },
+    "keywords": [
+        "soke",
+        "cli",
+        "授客AI",
+        "shouke",
+        "command-line"
+    ],
+    "author": "授客AI",
+    "license": "MIT",
+    "engines": {
+        "node": ">=14.0.0"
+    }
+}

package/scripts/build-binaries.sh

@@ -0,0 +1,88 @@
+#!/bin/bash
+
+# 多平台编译脚本
+# 用于编译 soke-cli 的所有平台二进制文件
+
+set -e
+
+# 颜色输出
+RED='\033[0;31m'
+GREEN='\033[0;32m'
+YELLOW='\033[1;33m'
+NC='\033[0m' # No Color
+
+# 获取版本号
+VERSION=$(node -p "require('./package.json').version")
+echo -e "${GREEN}开始编译 soke-cli v${VERSION}${NC}"
+
+# 编译参数
+LDFLAGS="-s -w -X main.Version=${VERSION}"
+
+# 创建输出目录
+BIN_DIR="bin"
+mkdir -p ${BIN_DIR}
+
+# 清理旧文件
+echo -e "${YELLOW}清理旧的编译文件...${NC}"
+rm -f ${BIN_DIR}/soke-cli-*
+
+# 编译函数
+build() {
+    local GOOS=$1
+    local GOARCH=$2
+    local OUTPUT=$3
+
+    echo -e "${YELLOW}编译 ${GOOS}-${GOARCH}...${NC}"
+
+    GOOS=${GOOS} GOARCH=${GOARCH} go build \
+        -ldflags "${LDFLAGS}" \
+        -o ${BIN_DIR}/${OUTPUT} \
+        .
+
+    if [ $? -eq 0 ]; then
+        local SIZE=$(du -h ${BIN_DIR}/${OUTPUT} | cut -f1)
+        echo -e "${GREEN}✓ ${OUTPUT} (${SIZE})${NC}"
+    else
+        echo -e "${RED}✗ ${OUTPUT} 编译失败${NC}"
+        exit 1
+    fi
+}
+
+# 编译所有平台
+echo ""
+echo "编译目标平台:"
+
+# macOS Intel
+build "darwin" "amd64" "soke-cli-darwin-amd64"
+
+# macOS Apple Silicon
+build "darwin" "arm64" "soke-cli-darwin-arm64"
+
+# Linux x64
+build "linux" "amd64" "soke-cli-linux-amd64"
+
+# Linux ARM64 (可选)
+# build "linux" "arm64" "soke-cli-linux-arm64"
+
+# Windows x64
+build "windows" "amd64" "soke-cli-windows-amd64.exe"
+
+echo ""
+echo -e "${GREEN}所有平台编译完成!${NC}"
+echo ""
+echo "编译产物:"
+ls -lh ${BIN_DIR}/soke-cli-*
+
+echo ""
+echo -e "${YELLOW}下一步:${NC}"
+echo "1. 创建 Git 标签: git tag v${VERSION}"
+echo "2. 推送标签: git push origin v${VERSION}"
+echo "3. 上传到 GitHub Releases:"
+echo "   gh release create v${VERSION} \\"
+echo "     ${BIN_DIR}/soke-cli-darwin-amd64 \\"
+echo "     ${BIN_DIR}/soke-cli-darwin-arm64 \\"
+echo "     ${BIN_DIR}/soke-cli-linux-amd64 \\"
+echo "     ${BIN_DIR}/soke-cli-windows-amd64.exe \\"
+echo "     --title \"v${VERSION}\" \\"
+echo "     --notes \"Release v${VERSION}\""
+echo "4. 发布到 NPM: npm publish --access public"

package/scripts/install.js

@@ -0,0 +1,127 @@
+const os = require('os');
+const path = require('path');
+const fs = require('fs');
+const https = require('https');
+const { execSync } = require('child_process');
+
+const platform = os.platform();
+const arch = os.arch();
+const version = require('../package.json').version;
+
+// 平台映射
+const platformMap = {
+  'darwin': 'darwin',
+  'linux': 'linux',
+  'win32': 'windows'
+};
+
+const archMap = {
+  'x64': 'amd64',
+  'arm64': 'arm64'
+};
+
+const mappedPlatform = platformMap[platform];
+const mappedArch = archMap[arch];
+
+if (!mappedPlatform || !mappedArch) {
+  console.error(`不支持的平台: ${platform}-${arch}`);
+  console.error('支持的平台: darwin-x64, darwin-arm64, linux-x64, windows-x64');
+  process.exit(1);
+}
+
+const binaryName = platform === 'win32' ? 'soke-cli.exe' : 'soke-cli';
+const binaryFileName = `soke-cli-${mappedPlatform}-${mappedArch}${platform === 'win32' ? '.exe' : ''}`;
+
+// GitHub Releases 下载地址
+const downloadURL = `https://github.com/liuchenlong1111/soke-cli/releases/download/v${version}/${binaryFileName}`;
+
+const binDir = path.join(__dirname, '..', 'bin');
+const binaryPath = path.join(binDir, binaryName);
+
+console.log(`正在为 ${mappedPlatform}-${mappedArch} 下载 soke-cli v${version}...`);
+console.log(`下载地址: ${downloadURL}`);
+
+// 创建 bin 目录
+if (!fs.existsSync(binDir)) {
+  fs.mkdirSync(binDir, { recursive: true });
+}
+
+// 下载文件
+function downloadFile(url, dest) {
+  return new Promise((resolve, reject) => {
+    const file = fs.createWriteStream(dest);
+
+    https.get(url, (response) => {
+      // 处理重定向
+      if (response.statusCode === 301 || response.statusCode === 302) {
+        file.close();
+        fs.unlinkSync(dest);
+        return downloadFile(response.headers.location, dest)
+          .then(resolve)
+          .catch(reject);
+      }
+
+      if (response.statusCode !== 200) {
+        file.close();
+        fs.unlinkSync(dest);
+        return reject(new Error(`下载失败，HTTP 状态码: ${response.statusCode}`));
+      }
+
+      const totalSize = parseInt(response.headers['content-length'], 10);
+      let downloadedSize = 0;
+      let lastPercent = 0;
+
+      response.on('data', (chunk) => {
+        downloadedSize += chunk.length;
+        const percent = Math.floor((downloadedSize / totalSize) * 100);
+        if (percent !== lastPercent && percent % 10 === 0) {
+          process.stdout.write(`\r下载进度: ${percent}%`);
+          lastPercent = percent;
+        }
+      });
+
+      response.pipe(file);
+
+      file.on('finish', () => {
+        file.close();
+        console.log('\r下载完成!                    ');
+        resolve();
+      });
+    }).on('error', (err) => {
+      file.close();
+      fs.unlinkSync(dest);
+      reject(err);
+    });
+  });
+}
+
+// 执行下载
+downloadFile(downloadURL, binaryPath)
+  .then(() => {
+    // 设置可执行权限（非 Windows 平台）
+    if (platform !== 'win32') {
+      try {
+        fs.chmodSync(binaryPath, 0o755);
+        console.log('已设置可执行权限');
+      } catch (err) {
+        console.error('设置可执行权限失败:', err.message);
+        process.exit(1);
+      }
+    }
+
+    console.log('soke-cli 安装成功!');
+    console.log(`二进制文件位置: ${binaryPath}`);
+    console.log('\n使用方法:');
+    console.log('  soke-cli --help');
+    console.log('  soke-cli config init');
+    console.log('  soke-cli auth login');
+  })
+  .catch((err) => {
+    console.error('\n安装失败:', err.message);
+    console.error('\n可能的原因:');
+    console.error('1. 网络连接问题');
+    console.error('2. GitHub Releases 中不存在该版本的二进制文件');
+    console.error('3. 不支持当前平台');
+    console.error('\n请访问 https://github.com/sokeai/soke-cli/releases 手动下载');
+    process.exit(1);
+  });

package/scripts/release.sh

@@ -0,0 +1,216 @@
+#!/bin/bash
+
+# soke-cli 自动化发布脚本
+# 完整流程: 编译 -> 创建标签 -> 上传 GitHub Releases -> 发布 NPM
+
+set -e
+
+# 颜色输出
+RED='\033[0;31m'
+GREEN='\033[0;32m'
+YELLOW='\033[1;33m'
+BLUE='\033[0;34m'
+NC='\033[0m'
+
+# 获取版本号
+VERSION=$(node -p "require('./package.json').version")
+
+echo -e "${BLUE}========================================${NC}"
+echo -e "${BLUE}  soke-cli 发布脚本 v${VERSION}${NC}"
+echo -e "${BLUE}========================================${NC}"
+echo ""
+
+# 检查必要的工具
+check_tools() {
+    echo -e "${YELLOW}检查必要工具...${NC}"
+
+    if ! command -v go &> /dev/null; then
+        echo -e "${RED}错误: 未安装 Go${NC}"
+        exit 1
+    fi
+
+    if ! command -v gh &> /dev/null; then
+        echo -e "${RED}错误: 未安装 GitHub CLI (gh)${NC}"
+        echo "安装方法: brew install gh"
+        exit 1
+    fi
+
+    if ! command -v npm &> /dev/null; then
+        echo -e "${RED}错误: 未安装 npm${NC}"
+        exit 1
+    fi
+
+    echo -e "${GREEN}✓ 所有工具已就绪${NC}"
+    echo ""
+}
+
+# 检查 Git 状态
+check_git_status() {
+    echo -e "${YELLOW}检查 Git 状态...${NC}"
+
+    if [ -n "$(git status --porcelain)" ]; then
+        echo -e "${RED}错误: 工作目录有未提交的更改${NC}"
+        echo "请先提交或暂存所有更改"
+        git status --short
+        exit 1
+    fi
+
+    echo -e "${GREEN}✓ 工作目录干净${NC}"
+    echo ""
+}
+
+# 检查标签是否已存在
+check_tag() {
+    echo -e "${YELLOW}检查标签 v${VERSION}...${NC}"
+
+    if git rev-parse "v${VERSION}" >/dev/null 2>&1; then
+        echo -e "${RED}错误: 标签 v${VERSION} 已存在${NC}"
+        echo "请更新 package.json 中的版本号"
+        exit 1
+    fi
+
+    echo -e "${GREEN}✓ 标签不存在，可以继续${NC}"
+    echo ""
+}
+
+# 运行测试
+run_tests() {
+    echo -e "${YELLOW}运行测试...${NC}"
+
+    if ! go test ./...; then
+        echo -e "${RED}错误: 测试失败${NC}"
+        exit 1
+    fi
+
+    echo -e "${GREEN}✓ 测试通过${NC}"
+    echo ""
+}
+
+# 编译所有平台
+build_binaries() {
+    echo -e "${YELLOW}编译所有平台...${NC}"
+
+    if ! ./scripts/build-binaries.sh; then
+        echo -e "${RED}错误: 编译失败${NC}"
+        exit 1
+    fi
+
+    echo -e "${GREEN}✓ 编译完成${NC}"
+    echo ""
+}
+
+# 创建并推送标签
+create_tag() {
+    echo -e "${YELLOW}创建 Git 标签 v${VERSION}...${NC}"
+
+    git tag -a "v${VERSION}" -m "Release v${VERSION}"
+    git push github "v${VERSION}"
+
+    echo -e "${GREEN}✓ 标签已创建并推送${NC}"
+    echo ""
+}
+
+# 上传到 GitHub Releases
+upload_github_release() {
+    echo -e "${YELLOW}上传到 GitHub Releases...${NC}"
+
+    # 生成 Release Notes（可以自定义）
+    RELEASE_NOTES="Release v${VERSION}
+
+## 安装方法
+
+\`\`\`bash
+npm install -g @sokeai/cli
+\`\`\`
+
+## 更新日志
+
+请查看 commit 历史了解详细更改。
+"
+
+    gh release create "v${VERSION}" \
+        bin/soke-cli-darwin-amd64 \
+        bin/soke-cli-darwin-arm64 \
+        bin/soke-cli-linux-amd64 \
+        bin/soke-cli-windows-amd64.exe \
+        --title "v${VERSION}" \
+        --notes "${RELEASE_NOTES}"
+
+    echo -e "${GREEN}✓ GitHub Release 创建成功${NC}"
+    echo ""
+}
+
+# 发布到 NPM
+publish_npm() {
+    echo -e "${YELLOW}发布到 NPM...${NC}"
+
+    # 检查是否已登录
+    if ! npm whoami &> /dev/null; then
+        echo -e "${RED}错误: 未登录 NPM${NC}"
+        echo "请先运行: npm login"
+        exit 1
+    fi
+
+    # 发布
+    npm publish --access public
+
+    echo -e "${GREEN}✓ NPM 包发布成功${NC}"
+    echo ""
+}
+
+# 清理编译产物
+cleanup() {
+    echo -e "${YELLOW}清理编译产物...${NC}"
+    rm -rf bin/
+    echo -e "${GREEN}✓ 清理完成${NC}"
+    echo ""
+}
+
+# 主流程
+main() {
+    echo -e "${BLUE}开始发布流程...${NC}"
+    echo ""
+
+    check_tools
+    check_git_status
+    check_tag
+    run_tests
+    build_binaries
+    create_tag
+    upload_github_release
+    publish_npm
+    cleanup
+
+    echo -e "${GREEN}========================================${NC}"
+    echo -e "${GREEN}  发布成功! 🎉${NC}"
+    echo -e "${GREEN}========================================${NC}"
+    echo ""
+    echo -e "版本: ${GREEN}v${VERSION}${NC}"
+    echo -e "NPM: ${BLUE}https://www.npmjs.com/package/@sokeai/cli${NC}"
+    echo -e "GitHub: ${BLUE}https://github.com/sokeai/soke-cli/releases/tag/v${VERSION}${NC}"
+    echo ""
+    echo "用户可以通过以下命令安装:"
+    echo -e "${YELLOW}npm install -g @sokeai/cli${NC}"
+}
+
+# 确认发布
+echo -e "${YELLOW}即将发布 soke-cli v${VERSION}${NC}"
+echo ""
+echo "发布流程包括:"
+echo "  1. 检查工具和 Git 状态"
+echo "  2. 运行测试"
+echo "  3. 编译所有平台二进制文件"
+echo "  4. 创建 Git 标签并推送"
+echo "  5. 上传到 GitHub Releases"
+echo "  6. 发布到 NPM"
+echo ""
+read -p "确认继续? (y/N) " -n 1 -r
+echo ""
+
+if [[ ! $REPLY =~ ^[Yy]$ ]]; then
+    echo "已取消发布"
+    exit 0
+fi
+
+echo ""
+main

package/scripts/run.js

@@ -0,0 +1,53 @@
+#!/usr/bin/env node
+
+const { spawn } = require('child_process');
+const path = require('path');
+const fs = require('fs');
+
+// 获取二进制文件路径
+const platform = process.platform;
+const binaryName = platform === 'win32' ? 'soke-cli.exe' : 'soke-cli';
+const binaryPath = path.join(__dirname, '..', 'bin', binaryName);
+
+// 检查二进制文件是否存在
+if (!fs.existsSync(binaryPath)) {
+  console.error('错误: 未找到 soke-cli 二进制文件');
+  console.error('请尝试重新安装: npm install -g @sokeai/cli');
+  process.exit(1);
+}
+
+// 检查二进制文件是否可执行
+try {
+  fs.accessSync(binaryPath, fs.constants.X_OK);
+} catch (err) {
+  // 如果不可执行，尝试设置权限
+  if (platform !== 'win32') {
+    try {
+      fs.chmodSync(binaryPath, 0o755);
+    } catch (chmodErr) {
+      console.error('错误: 无法设置二进制文件执行权限');
+      process.exit(1);
+    }
+  }
+}
+
+// 执行二进制文件，传递所有命令行参数
+const child = spawn(binaryPath, process.argv.slice(2), {
+  stdio: 'inherit',
+  env: process.env
+});
+
+// 处理子进程退出
+child.on('exit', (code, signal) => {
+  if (signal) {
+    process.kill(process.pid, signal);
+  } else {
+    process.exit(code);
+  }
+});
+
+// 处理错误
+child.on('error', (err) => {
+  console.error('执行 soke-cli 时出错:', err.message);
+  process.exit(1);
+});