cloudcc-cli 2.3.0 → 2.3.1

package/.cursor/skills/cloudcc-cli-dev/CLI_CHEATSHEET.md

@@ -2,16 +2,16 @@
 
 `package.json` 中定义的 bin：
 
-- `cc`：主入口（按模块分发 `create/get/pull/publish/detail/pullList/doc/use/approve/reject` 等）
-- `cloudccCreate`：创建模板项目（内部调用 `src/project/create.js`）
-- `cloudccBuild`：组件发布/构建相关（内部调用 `src/plugin/publish.js`）
-- `cc-mcp`：MCP 服务入口（运行在 IDE/MCP 客户端侧触发）
+- `cc`：主入口，统一使用 `cc <action> <type> ...`
+- `cloudccCreate`：项目模板创建入口（`bin/project.js`）
+- `cloudccBuild`：组件构建发布入口（`bin/plugin.js`）
+- `cc-mcp`：MCP 服务入口
 
 ---
 
 ## 统一调用约定
 
-命令格式（主入口分发）：
+主入口格式：
 
 ```bash
 cc <action> <type> [参数...]
@@ -25,191 +25,348 @@ cc <action> <type> [参数...]
 - `publish`
 - `detail`
 - `pullList`
+- `delete`
 - `doc`
+- `count`
 - `use`
 - `approve`
 - `reject`
 
+> 注意：`-v/-version/--version/--v` 为特殊入口，不需要 `type`。
+
+---
+
+## 命令覆盖矩阵（源码核对）
+
+以下为当前代码已接入的 `type -> action`：
+
+- `project`：`create`、`doc`
+- `config`：`use`、`get`
+- `token`：`get`
+- `brief`：`get`
+- `recordType`：`get`
+- `object`：`create`、`get`、`delete`
+- `fields`：`create`、`get`、`delete`
+- `menu`：`create`、`get`、`delete`
+- `application`：`create`、`get`、`delete`
+- `plugin`：`create`、`publish`、`get`、`detail`、`pull`、`delete`、`doc`
+- `customPage`：`create`、`get`、`delete`
+- `classes`：`create`、`publish`、`pull`、`get`、`detail`、`pullList`、`delete`、`doc`
+- `schedule`/`timer`（同一实现）：`create`、`publish`、`pull`、`get`、`detail`、`pullList`、`delete`
+- `scheduleJob`：`get`、`detail`、`delete`
+- `triggers`：`create`、`publish`、`pull`、`get`、`detail`、`pullList`、`delete`、`doc`
+- `script`：`create`、`publish`、`pull`、`get`、`detail`、`pullList`、`doc`
+- `approval`：`get`、`approve`、`reject`
+- `customSetting`：`create`、`get`、`detail`、`delete`、`doc`
+- `staticResource`：`get`、`detail`、`delete`、`count`、`doc`
+
 ---
 
 ## encodeURI JSON 参数提醒
 
-当某些命令需要传 JSON（例如触发器、定时类查询条件、自定义脚本等），建议用 `encodeURI(JSON.stringify(...))` 并用单引号/双引号把结果当作“单个参数”传入：
+触发器/定时类/脚本/审批等命令常要求 JSON 入参，建议统一：
 
 ```bash
-cc create triggers "$(node -e 'console.log(encodeURI(JSON.stringify({name:\"MyTrigger\",schemetableName:\"account\",targetObjectId:\"a01...\",triggerTime:\"beforeInsert\"})))')"
+ENCODED="$(node -e 'console.log(encodeURI(JSON.stringify({name:"MyTrigger",schemetableName:"account",targetObjectId:"a01...",triggerTime:"beforeInsert"})))')"
+cc create triggers "$ENCODED"
 ```
 
 ---
 
-## 常用 CLI 命令速查（按模块分组）
-
-### 项目与文档
-
-```bash
-# 创建模板项目
-cc create project <projectName>
-
-# 生成/输出文档（纯 CLI 文档）
-cc doc project overview
-cc doc project key-guide
-```
+## 常用命令速查（按模块）
 
-### 配置、token、brief、recordType、版本
+### 版本与基础配置
 
 ```bash
 # 版本
 cc -v
+cc --version
 
-# 配置文件管理
+# 切换/查看 cloudcc-cli.config.js 当前环境
 cc use config <env> [projectPath]
 cc get config [projectPath]
 
-# 从 CloudCC 获取 bus token（依赖你已配置的 dev 配置）
+# 获取 bus token
 cc get token <projectPath>
 
-# 获取页面/脚本相关的角色信息（brief）
+# 获取简档信息（常用于对象/字段/应用等创建流程）
 cc get brief <projectPath>
 
-# 拉取记录类型列表（需要 objprefix）
+# 获取记录类型
 cc get recordType <projectPath> <prefix>
 ```
 
-### 自定义对象（object）与字段（fields）
+### 项目（project）
+
+```bash
+# 创建项目模板
+cc create project <projectName>
+
+# CLI 文档
+cc doc project
+```
+
+### 对象与字段
 
 ```bash
-# 创建自定义对象
-# nameLabel 可选；如果不传 nameLabel，会从 label 自动生成
+# 创建对象（nameLabel 可选，不传则按 label 自动生成）
 cc create object <projectPath> <label> [nameLabel]
 
-# 查询对象列表
-# type 可选：standard / custom / both（也支持 chat / trigger / fields 等内部类型）
+# 查询对象：type 可选
+# 常见值：standard / custom / chat / trigger / fields（不传表示全部）
+# 注意：type=fields 时还需要第 3 个参数（encodedObjectJson）
 cc get object <projectPath> [type]
 
-# 查询对象字段（推荐直接用 fields 模块）
+# type=fields 示例（第三参需包含 objprefix）
+cc get object <projectPath> fields <encodedObjectJson>
+
+# 删除对象
+cc delete object <projectPath> <objid>
+
+# 查询字段
 cc get fields <projectPath> <objprefix>
 
 # 创建字段
-# fieldType 支持：S/U/SCORE/IMG/P/C/J/H/E/B/A/D/F/T/N/ENC/ENCD/X/L/Q/AD/LT/FL/Y/MR/M
+# fieldType: S/U/SCORE/IMG/P/C/J/H/E/B/A/D/F/T/N/ENC/ENCD/X/L/Q/AD/LT/FL/Y/MR/M
 cc create fields <projectPath> <fieldType> <objid> <nameLabel> [ptext|lookupObj]
+
+# 删除字段（彻底删除）
+cc delete fields <projectPath> <fieldId> <objid>
 ```
 
-### 菜单（menu）与应用（application）
+### 菜单与应用
 
 ```bash
-# 创建菜单（标签页）
-# type: object | page | script | site
-# path: 项目路径（用于读取 cloudcc-cli.config.js）
-cc create menu <type> <path> <resourceId> <tabName> [tabStyle] [mobileimg] [cloudccservicetab]
+# 创建菜单（object）
+cc create menu object <path> <objectId> <tabName> [tabStyle] [mobileimg] [cloudccservicetab]
+
+# 创建菜单（page）
+# pageApi 会在内部自动拼接为 lightningPage（pageApi + "#lightning"）
+# 如已传入 xxx#lightning，也可兼容
+cc create menu page <path> <pageApi> <tabName> <pname> [tabStyle] [mobileimg] [cloudccservicetab] [mobileurl]
+
+# 创建菜单（script / site）
+cc create menu script <path> <scriptId> <tabName> [tabStyle] [mobileimg] [cloudccservicetab]
+cc create menu site <path> <siteId> <tabName> [tabStyle] [mobileimg] [cloudccservicetab]
 
-# 创建应用
-# menuIds 可选，多个用逗号分隔（内部会确保包含默认菜单 acf000001）
+# 查询菜单（condJson 可选，需 encodeURI）
+cc get menu <path> [encodedCondJson]
+
+# 删除菜单
+cc delete menu <path> <tabId>
+
+# 创建应用（menuIds 可选，逗号分隔）
 cc create application <path> <appName> <appCode> [menuIds]
 
-# 获取应用（当前实现返回空列表）
-cc get application <path>
+# 获取应用列表（condJson 可选，需 encodeURI）
+cc get application <path> [encodedCondJson]
+
+# 删除应用
+cc delete application <path> <appId>
 ```
 
-### 自定义组件（plugin / plugins）
+说明：
+
+- `create menu page` 中 `pageType` 固定为 `customPage`（内部写死）。
+- `create menu page` 中 `mobileurl` 默认 `""`。
+- `cc get menu` 会兼容接口分组返回（如 `botlist/objectlist/pagelist/...`），并汇总为数组输出；每项包含 `__group` 字段标记来源分组。
+
+### 组件（plugin）
 
 ```bash
-# 创建到 plugins/<pluginName>/
+# 创建本地组件模板
 cc create plugin <pluginName>
 
-# 发布（编译并上传）
+# 发布组件
 cc publish plugin <pluginName>
 
-# 拉取（可传组件名或 ID）
+# 拉取组件（name 或 id）
 cc pull plugin <pluginNameOrId> [projectPath]
 
-# 列表
+# 获取列表
 cc get plugin <projectPath>
 
-# 详情
-# pluginName/pluginId（二选一即可；要传 id 时可以把 pluginName 置空 ""）
+# 详情（name 与 id 二选一；仅查 id 时可把 name 传空字符串）
 cc detail plugin <pluginName> <pluginId> [projectPath]
+
+# 删除云端组件（name 或 id）
+cc delete plugin <pluginNameOrId> [projectPath]
+
+# 组件文档
+cc doc plugin
 ```
 
-### 后端自定义类（classes）
+### 自定义页面（customPage）
 
 ```bash
-# 注意：当前 `src/classes/index.js` 仅接入 `doc`。
-# create/pull/publish/get/detail/pullList 这些命令在代码层面存在（src/classes/*.js），但未挂载到 CLI 类型分发里。
-cc doc classes
+# 创建页面（pluginId 或 compLabel 均可）
+cc create customPage <pageLabel> <pageApi> <pluginId|compLabel> [projectPath]
+
+# 获取页面列表（pageNo/pageSize 可选）
+cc get customPage [pageNo] [pageSize] [projectPath]
+
+# 删除页面
+cc delete customPage <pageId> [projectPath]
+```
+
+### 后端类（classes）
 
-# 如果后续你把 classes/index.js 挂载齐全，可按下面命令使用（实现已存在）：
+```bash
 cc create classes <ClassName>
-cc pull classes <ClassName>
 cc publish classes <ClassName>
+cc pull classes <ClassName>
+
+# 查询列表（condJson 需 encodeURI）
 cc get classes <encodedCondJson> <projectPath>
+
+# 详情（本地优先；也可仅传 id）
 cc detail classes <ClassName> <ClassId>
+
+# 批量拉取
 cc pullList classes <ClassId> <ProjectRoot>
+
+# 删除（传类名或类 id，类名时会优先读本地 config.json 的 id）
+cc delete classes <ClassNameOrId> [projectPath]
+
+# 文档
+cc doc classes
 ```
 
-### 后端定时类（schedule / timer）
+### 定时类（schedule / timer）
 
 ```bash
-# 创建（schedule 或 timer 二选一）
+# schedule 与 timer 是同义 type
 cc create schedule <ScheduleName>
-cc create timer <ScheduleName>
-
-# 拉取/发布（本地目录 schedule/<ScheduleName>/）
-cc pull schedule <ScheduleName>
 cc publish schedule <ScheduleName>
+cc pull schedule <ScheduleName>
 
-cc pull timer <ScheduleName>
+cc create timer <ScheduleName>
 cc publish timer <ScheduleName>
+cc pull timer <ScheduleName>
 
-# 列表（查询条件 JSON，需 encodeURI）
+# 列表查询（condJson 需 encodeURI）
 cc get schedule <encodedCondJson> <projectPath>
 
 # 详情
 cc detail schedule <ScheduleName> <ScheduleId>
 
-# 批量拉取并生成本地 files：schedule/<name>/
+# 批量拉取
 cc pullList schedule <ScheduleId> <ProjectRoot>
+
+# 删除定时类（传名称或 id）
+cc delete schedule <ScheduleNameOrId> [projectPath]
+```
+
+### 定时作业（scheduleJob）
+
+```bash
+# 列表（可选条件）
+cc get scheduleJob <projectPath> [encodedCondJson]
+
+# 详情
+cc detail scheduleJob <jobId> [projectPath]
+
+# 删除
+cc delete scheduleJob <jobId> [projectPath]
 ```
 
-### 后端触发器（triggers）
+### 触发器（triggers）
 
 ```bash
-# 创建：参数是 encodeURI(JSON)（必传：name/schemetableName/targetObjectId/triggerTime）
+# 创建（必含 name/schemetableName/targetObjectId/triggerTime）
 cc create triggers <encodedJson>
 
-# 拉取/发布
-# namePath 形如：<schemetableNameLower>/<triggerName>
-cc pull triggers <namePath>
+# namePath: <schemetableNameLower>/<triggerName>
 cc publish triggers <namePath>
+cc pull triggers <namePath>
 
-# 列表（查询条件 JSON，需 encodeURI）
+# 列表查询（condJson 需 encodeURI）
 cc get triggers <encodedCondJson> <projectPath>
 
-# 详情（本地优先；也可只用 id）
+# 详情（本地优先；也可仅查 id）
 cc detail triggers <namePath> <triggerId>
 
-# 批量拉取并生成本地 triggers/<objectName>/<triggerName>/
+# 批量拉取
 cc pullList triggers <triggerId> <ProjectRoot>
+
+# 删除（传 namePath 或 id）
+cc delete triggers <objectName/triggerName|triggerId> [projectPath]
+
+# 文档
+cc doc triggers
 ```
 
 ### 客户端脚本（script）
 
 ```bash
-# 创建：参数是 encodeURI(JSON)（内部使用 body.objName/body.scriptName）
+# 创建（JSON 需包含 objName/scriptName 等）
 cc create script <encodedJson>
 
-# 拉取/发布：scriptPath 形如 objName/scriptName
-cc pull script <objName/scriptName>
+# scriptPath: <objName>/<scriptName>
 cc publish script <objName/scriptName>
+cc pull script <objName/scriptName>
 
-# 列表（查询条件 JSON + 项目路径）
+# 列表查询
 cc get script <encodedCondJson> <projectPath>
 
-# 详情（本地优先；也可只用 id）
-cc detail script <objName/scriptName> <scriptId> <projectPath>
+# 详情
+cc detail script <objName/scriptName> <scriptId> [projectPath]
 
-# 批量拉取并生成目录：script/<objName>/<scriptName>/
+# 批量拉取
 cc pullList script <scriptId> <ProjectRoot>
 
 # 文档
 cc doc script
 ```
+
+### 审批（approval）
+
+```bash
+# 查询待审批列表（queryJson 可选，建议 encodeURI）
+cc get approval <projectPath> [encodedQueryJson]
+
+# 审批通过（approvalJson 建议 encodeURI）
+cc approve approval <projectPath> <encodedApprovalJson>
+
+# 审批拒绝（approvalJson 建议 encodeURI）
+cc reject approval <projectPath> <encodedApprovalJson>
+```
+
+### 文档型 type
+
+```bash
+cc doc customSetting
+cc doc staticResource
+```
+
+### 自定义设置（customSetting）
+
+```bash
+# 列表
+cc get customSetting <projectPath> [encodedCondJson]
+
+# 详情
+cc detail customSetting <projectPath> <settingId>
+
+# 创建/编辑（save，body 透传）
+cc create customSetting <projectPath> <encodedBodyJson>
+
+# 删除
+cc delete customSetting <projectPath> <settingId>
+```
+
+### 静态资源（staticResource）
+
+```bash
+# 列表
+cc get staticResource <projectPath> [encodedCondJson]
+
+# 详情
+cc detail staticResource <projectPath> <resourceId>
+
+# 删除
+cc delete staticResource <projectPath> <resourceId>
+
+# 容量统计
+cc count staticResource <projectPath> [encodedCondJson]
+```