@cloudglab/yapi-cli 0.0.1

package/skills/yapi-cli/reference/interface.md

@@ -0,0 +1,185 @@
+# 接口
+
+## 强制判断
+
+先确认用户意图：
+- **搜索接口** → 关键词搜索，可选 `projectId` 收窄范围
+- **接口列表** → 按项目查询，支持 status/method 过滤
+- **接口详情** → 需要 `interfaceId`
+- **创建 / 更新 / 删除** → 写操作，需要 `--confirm true`
+- **分类（Category）** → 项目的接口分组
+- **Mock** → 接口级 Mock 开关和自定义脚本
+- **日志** → 接口变更历史
+- **导出** → 按项目导出接口定义
+- **集合（Collection）** → 测试集合和用例
+
+## 搜索
+
+### 接口搜索
+
+```bash
+yapi search --q <keyword> [--projectId <id>] [--page 1] [--limit 50]
+```
+
+全局关键词搜索，支持按项目收窄范围。
+
+### 接口列表
+
+```bash
+yapi interface-list --projectId <id> [--status <s>] [--method <m>] [--page <n>] [--limit <n>]
+```
+
+`--status`：`done`（已完成）、`undone`（未完成）
+`--method`：`GET`、`POST`、`PUT`、`DELETE`
+
+### 接口详情
+
+```bash
+yapi interface-get --interfaceId <id>
+```
+
+返回接口完整定义：路径、方法、请求参数、响应示例、Mock 状态等。
+
+## 分类
+
+### 分类列表
+
+```bash
+yapi category-list --projectId <id>
+```
+
+### 分类排序
+
+```bash
+yapi interface-up-cat-index --catid <id> --index <n> --confirm true
+```
+
+## CRUD
+
+### 创建接口
+
+```bash
+yapi interface-create --projectId <id> --catId <id> --title <title> --path <path> [--method GET] [--desc <desc>] --confirm true
+```
+
+### 更新接口
+
+```bash
+yapi interface-update --interfaceId <id> [--title <t>] [--path <p>] [--method <m>] --confirm true
+```
+
+### 删除接口
+
+```bash
+yapi interface-delete --interfaceId <id> --confirm true
+```
+
+## Mock
+
+### Mock 开关
+
+```bash
+yapi interface-mock-toggle --interfaceId <id> [--open true] --confirm true
+```
+
+### Mock 脚本
+
+```bash
+yapi interface-mock-script --interfaceId <id> --script <script> --confirm true
+```
+
+YApi Mock 脚本在沙箱中执行，支持：
+- `mockJson` — 修改 Mock 返回 JSON
+- `httpCode` — 修改状态码（默认 200）
+- `resHeader` — 修改响应头
+- `delay` — 设置延迟（毫秒）
+
+示例脚本：
+
+```js
+mockJson = { code: 0, data: { id: 1, name: 'mock' }, message: 'success' };
+httpCode = 200;
+delay = 500;
+```
+
+## 其他
+
+### 原始请求
+
+```bash
+yapi request --path /api/endpoint [--method GET] [--body <json>]
+```
+
+走 YApi 认证，发送任意 HTTP 请求。
+
+### 日志
+
+```bash
+yapi log --interfaceId <id> [--projectId <id>]
+```
+
+接口变更历史记录。
+
+### 导出
+
+```bash
+yapi export --projectId <id> [--type json]
+```
+
+`--type`：`json`、`swagger`、`openapi3`
+
+### 下载 CRX
+
+```bash
+yapi interface-download-crx
+```
+
+下载 YApi 跨域请求插件。
+
+## 集合
+
+### 集合列表
+
+```bash
+yapi col-list --projectId <id>
+```
+
+### 集合用例
+
+```bash
+yapi col-cases --projectId <id> --colId <id>
+```
+
+## 参数对照
+
+| 参数名 | 类型 | 必填 | 说明 |
+|--------|------|------|------|
+| `interfaceId` | number | get/update/delete/log/toggle/script | 接口 ID |
+| `projectId` | number | list/create/export/col | 项目 ID |
+| `catId` | number | interface-create | 分类 ID |
+| `catid` | number | up-cat-index | 分类 ID |
+| `title` | string | create/update | 接口标题 |
+| `path` | string | create | 接口路径 |
+| `method` | string | 否 | HTTP 方法 |
+| `q` | string | search | 搜索关键词 |
+| `confirm` | boolean | 写操作 | 确认执行 |
+
+## 常见链路
+
+```bash
+# 搜索 → 查详情 → 看日志
+yapi search --q <keyword> --limit 10
+yapi interface-get --interfaceId <id>
+yapi log --interfaceId <id>
+
+# 创建接口步骤
+yapi category-list --projectId <id>
+yapi interface-create --projectId <id> --catId <cid> --title <t> --path <p> --confirm true
+yapi interface-mock-script --interfaceId <id> --script <s> --confirm true
+yapi interface-list --projectId <id>
+
+# 接口完整上下文
+yapi interface-get --interfaceId <id>
+yapi interface-mock-toggle --interfaceId <id>
+yapi log --interfaceId <id>
+```

package/skills/yapi-cli/reference/overview.md

@@ -0,0 +1,52 @@
+# Overview
+
+yapi-cli 是 YApi 的命令行客户端，基于 InMemoryCliRegistry + Zod schema + jsonResult 模式构建。
+
+## 架构
+
+```
+src/
+  bin/yapi.js               — 入口脚本
+  cli.ts                    — CLI 运行器（内置命令：help/version/doctor/changelog/completion）
+  core/
+    cli-registry.ts         — InMemoryCliRegistry（命令注册 + 参数解析）
+    cli-output.ts           — 帮助输出渲染
+    errors.ts               — CliError 分层错误
+    output.ts               — OutputFormatter（pretty / json 双模式）
+    write-guard.ts          — 写保护（YAPI_DISABLE_WRITE + confirm）
+    doctor.ts               — 自检命令
+    changelog.ts            — 版本变更解析
+    completion.ts           — Shell 补全生成
+    update-probe.ts         — npm 版本探测
+  install.ts                — 安装/更新/卸载
+  services/yapi/            — YApi 服务层
+    api.ts                  — YApi API 客户端（101 路由端点全覆盖）
+    auth.ts                 — 认证管理（Token + JWT Cookie + LDAP）
+    config.ts               — 配置管理（JSON）
+    cache.ts                — 缓存
+    authCache.ts            — 认证缓存持久化
+    logger.ts               — 日志
+    types.ts                — 类型定义
+  tools/yapi/
+    register.ts             — 命令注册组合器
+    register-auth.ts        — 认证/配置命令
+    register-group.ts       — 分组命令
+    register-project.ts     — 项目命令
+    register-interface.ts   — 接口命令
+    register-util.ts        — 用户/集合/工具命令
+    register-test.ts        — 测试命令
+    utils.ts                — 工具函数
+    docs-sync.ts            — 文档同步
+```
+
+## 认证方式
+
+- **Token 认证**：通过 `login --token <t>` 或 `config-init --token <t>` 设置
+- **JWT Cookie 认证**：通过 `login --email <e> --password <p>` 密码登录（支持 LDAP/本地账号）
+- **LDAP 专用**：`login --email <e> --password <p>`，YApi 服务端自动识别 LDAP 并处理 PBKDF2 加密
+
+## 配置位置
+
+- CLI 配置：`~/.yapi/config.json`
+- 认证缓存：`~/.yapi/.yapi-auth`
+- API 缓存：`~/.yapi/.yapi-cache/cache.json`

package/skills/yapi-cli/reference/project.md

@@ -0,0 +1,115 @@
+# 项目
+
+## 强制判断
+
+先确认用户想查什么维度的项目信息：
+- **项目列表** → 查全量或按分组过滤
+- **项目详情** → 需要 `projectId`
+- **环境配置** → 需要 `projectId`
+- **项目成员** → 需要 `projectId`
+- **关注项目** → 查我关注的，不需要参数
+- **Mock 配置** → 项目级 Mock 开关和脚本
+
+## 查询
+
+### 项目列表
+
+```bash
+yapi project-list [--groupId <id>] [--page 1] [--limit 50]
+```
+
+`--groupId` 可选，不传时查全部可见项目。
+
+### 项目详情
+
+```bash
+yapi project-get --projectId <id>
+```
+
+返回项目基本信息、分组、创建时间、统计等。
+
+### 项目 Token
+
+```bash
+yapi project-token --projectId <id>
+```
+
+获取项目的 API Token。
+
+### 环境配置
+
+```bash
+yapi env --projectId <id>
+```
+
+列出项目环境变量（域名、header 等）。
+
+### 项目成员
+
+```bash
+yapi member --projectId <id>
+```
+
+### 修改成员角色
+
+```bash
+yapi member-change-role --projectId <id> --memberUid <uid> --role <role> --confirm true
+```
+
+`--role` 支持：`owner`、`dev`、`guest`、`developer`、`viewer`
+
+### 关注项目
+
+```bash
+yapi follow
+```
+
+列出当前用户关注的项目。
+
+## 写入
+
+### Mock 开关
+
+```bash
+yapi project-mock-toggle --projectId <id> [--open true] --confirm true
+```
+
+### Mock 脚本
+
+```bash
+yapi project-mock-script --projectId <id> --script <script> --confirm true
+```
+
+设置项目级全局 Mock 脚本。脚本在沙箱中执行，可操控 `mockJson`、`httpCode`、`resHeader`、`delay`。
+
+## 参数对照
+
+| 参数名 | 类型 | 必填 | 说明 |
+|--------|------|------|------|
+| `projectId` | number | 大多数操作 | 项目 ID |
+| `groupId` | number | project-list 筛选 | 分组 ID |
+| `page` | number | 否 | 页码（默认 1） |
+| `limit` | number | 否 | 每页数（默认 50） |
+| `memberUid` | number | member-change-role | 成员用户 ID |
+| `role` | string | member-change-role | 角色枚举 |
+| `open` | boolean | mock-toggle | 是否开启 |
+| `script` | string | mock-script | Mock 脚本内容 |
+| `confirm` | boolean | 写操作 | 确认执行 |
+
+## 常见链路
+
+```bash
+# 查项目完整信息
+yapi project-get --projectId <id>
+yapi env --projectId <id>
+yapi member --projectId <id>
+yapi interface-list --projectId <id> --limit 50
+
+# 配置 Mock
+yapi project-mock-toggle --projectId <id> --open true --confirm true
+yapi project-mock-script --projectId <id> --script 'mockJson={code:0}' --confirm true
+
+# 分组成员管理
+yapi member --projectId <id>
+yapi member-change-role --projectId <id> --memberUid <uid> --role dev --confirm true
+```

package/skills/yapi-cli/reference/test.md

@@ -0,0 +1,130 @@
+# 测试
+
+## 强制判断
+
+测试命令用于发送 HTTP 请求并查看响应，主要用于接口调试和验证：
+
+- **标准 HTTP 测试** → 测试 GET/POST/PUT/DELETE/HEAD/OPTIONS/PATCH
+- **上传测试** → 单文件或多文件上传
+- **响应分析** → 检查状态码、原始响应、响应结构
+- **自动测试** → 运行项目预设的自动测试
+
+所有测试命令都接受 `--url <url>` 参数（完整 URL，不是路径），不需要 YApi 认证。
+
+## HTTP 方法测试
+
+### GET
+
+```bash
+yapi test-get --url https://api.example.com/endpoint [--params '{"key":"value"}']
+```
+
+`--params` 为 JSON 字符串，转为查询参数。
+
+### POST
+
+```bash
+yapi test-post --url https://api.example.com/endpoint [--body '{"key":"value"}']
+```
+
+`--body` 为 JSON 字符串，作为请求体。
+
+### PUT / DELETE / PATCH
+
+```bash
+yapi test-put --url https://api.example.com/endpoint [--body <json>]
+yapi test-delete --url https://api.example.com/endpoint
+yapi test-patch --url https://api.example.com/endpoint [--body <json>]
+```
+
+### HEAD / OPTIONS
+
+```bash
+yapi test-head --url https://api.example.com/endpoint
+yapi test-options --url https://api.example.com/endpoint
+```
+
+## 上传测试
+
+### 单文件上传
+
+```bash
+yapi test-single-upload --url https://api.example.com/upload --filePath /path/to/file
+```
+
+### 多文件上传
+
+```bash
+yapi test-files-upload --url https://api.example.com/upload --filePaths /path/a --filePaths /path/b [--params <json>]
+```
+
+## 响应分析
+
+### 状态码检查
+
+```bash
+yapi test-http-code --url https://api.example.com/endpoint
+```
+
+只返回 HTTP 状态码。
+
+### 原始响应
+
+```bash
+yapi test-raw --url https://api.example.com/endpoint
+```
+
+查看原始文本响应，不解析 JSON。
+
+### 响应结构
+
+```bash
+yapi test-response --url https://api.example.com/endpoint
+```
+
+查看完整响应结构（状态码、头、体）。
+
+## 自动测试
+
+### 运行自动测试
+
+```bash
+yapi run-auto-test --projectId <id> [--format json]
+```
+
+调用 YApi 项目的自动测试功能。
+
+### 项目接口数据
+
+```bash
+yapi project-interface-data --projectId <id>
+```
+
+查询项目接口测试数据。
+
+## 参数对照
+
+| 参数名 | 类型 | 必填 | 说明 |
+|--------|------|------|------|
+| `url` | string | 全部测试命令 | 完整 URL |
+| `body` | string | post/put/patch | JSON 请求体 |
+| `params` | string | get/files-upload | JSON 查询参数 |
+| `filePath` | string | single-upload | 上传文件路径 |
+| `filePaths` | string[] | files-upload | 多文件上传路径 |
+| `projectId` | number | run-auto-test | 项目 ID |
+| `format` | string | 否 | 输出格式（json） |
+
+## 常见链路
+
+```bash
+# 先查接口定义，再测试
+yapi interface-get --interfaceId <id>
+yapi test-get --url https://api.example.com/path
+
+# 调试上传
+yapi test-single-upload --url https://api.example.com/upload --filePath ./test.png
+
+# 全链路验证
+yapi test-http-code --url https://api.example.com/health
+yapi test-response --url https://api.example.com/health
+```