About hap-cli-app-editor
hap-cli-app-editor is an agent skill for making precise changes to existing HAP apps, aimed at users managing app structure and workflows. It separates direct CLI edits from higher-risk edit-spec operations and emphasizes inspecting, validating, and verifying changes.
Key features
- 01Edit worksheets, fields, views, and permissions
- 02Manage workflows, pages, and custom actions
- 03Use edit-spec for complex read-modify-write edits
- 04Guide inspection, dry runs, and verification
- 05Cover deletion safeguards and data risks
Use cases
- 01Adjust fields or views in an existing app
- 02Edit workflow nodes and publish a workflow
- 03Add, remove, or change page components or action buttons
Install
Copy the command and run it in a terminal.
npx skills add https:/ / github.com/ mingdaocom/ hap-skills --skill hap-cli-app-editorAfter installing, type/hap-cli-app-editorin Claude Code to confirm it loaded.
Bundled files
References and scripts installed along with SKILL.md.
.gitignoreexamples/custom-action.edit.jsonfield-edits.edit.jsonpage-and-components.edit.jsonreferences/application.mdcharts.mdcustom-actions.mdcustom-pages.mdedit-spec.mdnodes.mdroles.mdviews.mdworkflows.mdworksheets-and-fields.mdreferences/scenarios/dashboard-page-build.mdfix-half-built-app.mdnew-field-full-chain.mdworkflow-node-rework.mdscripts/editspec/component.schema.jsoncustom-action.schema.jsonenvelope.schema.jsonfield.schema.jsonscripts/types/filter-condition.schema.jsonoperate-condition.schema.jsonsort-item.schema.jsonwire-control.schema.jsonworkflow-accounts.schema.jsonworkflow-field-write.schema.jsonDetails
From the project READMEHAP 应用编辑器(细粒度元素 CRUD)
你对一个已存在的 HAP 应用做精确的局部修改:增、删、改单个元素(工作表 / 字段 / 视图 / 角色权限 / 自定义动作 / 工作流与节点 / 自定义页面与组件 / 应用与分组)。 如果是要增删改业务数据,请遵从 hap-cli 主 Skill 直接调用 hap 命令.
核心模型:两个入口,按危险度分流
默认入口是裸 hap 命令 —— 绝大多数元素编辑就是一条命令:
hap worksheet view update <ws_id> <view_id> --name "进行中的订单"
hap workflow publish <process_id>
hap app role add-member <role_id> --user-ids <account_id> -a <app_id>
只有三类编辑走 edit-spec(hap app-editor),因为它们的安全写法是「读出整体 → 改一处 → 整体写回」,徒手做容易静默丢数据:
| 编辑对象 | edit-spec op | 为什么不能裸做 |
|---|---|---|
| 已有字段的修改/删除/重排 | field.update / field.delete / field.reorder | 必须整表控件集写回,否则系统反向控件会被静默丢掉 |
| 页面组件增删改 | component.add / component.update / component.delete | 页面布局是一个整体 components 数组,必须读改写 |
| 动作按钮新建/修改 | custom-action.create / custom-action.update | 高层 action_spec 自动翻译成按钮配置并接好关联流程 |
(新增字段 field.add 也在 edit-spec 里,与其它 field op 用同一份写法。)其余一切元素——工作表、视图、角色、工作流、节点、页面本身、应用与分组——直接用命令,各模块的命令与参数字典见下方索引。
前置条件
- 登录:
hap auth whoami确认已登录且选好组织;未登录让用户先hap auth login。 - 管理员权限(硬性前提):编辑应用元素要求当前用户对该应用有管理权限。动手前用
hap app list-managed确认目标 app 在列表里;不在则不要硬试,告知用户需要管理员授权或换账号登录。 - 上下文中没有 appId 时,让用户提供应用名或 appId。
通用工作流(4 步)
- Inspect:
hap app-editor inspect <appId或应用名>打印应用的「逻辑名 → id」全结构(工作表、视图、角色、工作流、页面、分组…)。后续命令要的各种 id 都从这里拿;更细的 id 用各模块的 list/info 命令。 - Read(改复杂值前必做):先用读命令导出现状,在真实结构上改,再写回。
- 视图:
hap --json worksheet view info <ws_id> <view_id> - 节点:
hap --json workflow node get <process_id> <node_id> - 字段:
hap --json worksheet fields <ws_id> --raw - 页面:
hap --json custom-page info <page_id>(参数是页面 id) 字典没覆盖的键,以读到的实际结构为准——照形改写永远是安全的。
- 视图:
- Edit:按模块文档的调用范式执行命令;或对三类 edit-spec 编辑:写 spec →
hap app-editor validate <spec.json>(纯本地)→plan(dry-run 预演)→apply。 - Verify:用对应读命令确认改动生效。
🚨 六个「返回成功但其实没做对」的坑
HAP 的写接口大量存在「照样返回成功、数据却是错的」,所以第 4 步 Verify 不是可选项:
update-fields是整表替换——没传的列连同数据一起删掉;条目不带id会被当成新列重建。 给已有表加列一律用add-fields或field.add。保存前先--check,保存后看自动回读的报告。- 自造
controlId会建出在表格和关联控件里永远读不出值的空白列。新建字段一律省略它。 - 选项/地区传了不存在的值不会报错,会写进一个无效值,界面显示空白(详见
hap guide record)。 --view-id撤动作按钮只对「限定了显示视图」的按钮有效;全视图按钮会明确报错,不会假装撤下。- 工作流建完不等于建好——触发器没绑、
fill_in没有可编辑字段,只有workflow publish会告诉你。 加完节点顺手发一次。 - 复制工作表时没被
--keep-relation点名的关联/子表/级联列会变成纯文本,且没有任何提示。
值形态约定(读字典表时)
各模块字典表的「值形态」列分三档:
- 标量/枚举:可取值直接写在格内,如
"1"=显示 "2"=隐藏; - 简单结构:一行描述,如
controlId 的 JSON 数组; - 复杂结构:链接到 scripts/types/ 下的类型定义(schema + 可直接套用的示例),全 skill 每个结构只定义一次:
| 类型 | 用在哪 |
|---|---|
| FilterCondition | 视图筛选、业务规则、按钮 enableWhen、图表筛选、页面筛选组件的存储形态(读回时看到的);写入时优先用统一筛选写法 {logic, items:[{field, op, value}]},见 hap guide record filter |
| SortItem | 视图多重排序、工作流节点 sorts |
| WireControl | 字段的原始控件对象(读写通用货币) |
| OperateCondition | 工作流节点/分支条件(不是 FilterCondition,字段名是 filedId) |
| WorkflowAccounts | 工作流收件人(type 语义反直觉,必读) |
| WorkflowFieldWrite | 数据节点字段写入($nodeId-fieldId$ 动态模板) |
一个典型的 HAP 工作表视图页面地址:/app/<app_id>/<section_id>/<worksheet_id>/<view_id>。一个典型的 HAP 工作表行记录页面地址:/app/<app_id>/<worksheet_id>/<view_id>/row/<rowid>。
模块文档索引
按要操作的元素只读对应那一份(每份 = 调用范式 + 数据字典):
- references/worksheets-and-fields.md — 工作表、字段(含 field edit-spec 写法)
- references/views.md — 视图(editAttrs / advancedSetting 全字典)
- references/roles.md — 角色、权限、成员
- references/workflows.md — 自动化工作流与节点基础
- references/nodes.md — 节点配置深度字典(8 类高频节点)
- references/custom-actions.md — 动作按钮(action_spec / wire 两种写法)
- references/custom-pages.md — 自定义页面与组件(含 component edit-spec 写法)
- references/application.md — 应用本身与导航分组
- references/charts.md — 统计图(改已有的图;规格本体见
hap guide chart) - references/edit-spec.md — edit-spec 信封与三类 op 的完整语义
多元素联动场景(一个目标要串多条命令)见 references/scenarios/,每个场景一份文档,含命令顺序与 id 传递。三类 edit-spec 的可直接套用样例在 examples/(field / component / custom-action 各一份)。
边界与纪律
- 只改用户明确要求的元素。
- 破坏性操作:edit-spec 的删除类 op 必须带
"confirm": true;裸命令的删除类一律带--yes/-y二次确认,不传-y时会交互式询问(非交互环境下直接中止)。-y只是跳过提示,不等于授权——任何删除动手前都先取得用户明确同意。删完用hap app trash -a <appId>核对:工作表 / 自定义页 / AI 助手默认都是进应用回收站,在回收站里看到它才说明删成功了。 - 不猜参数:字典 + 读命令导出的现状是唯一依据;两者冲突时以读到的为准。
hap-cli会自动升级,命令和选项会变。 本 skill 的字典核对于 0.9.0,只是加速器,不是权威: 动手前用hap <命令> --help核准确参数,用hap guide worksheet/hap guide workflow/hap guide chart/hap guide record核值形态与陷阱——它们随本机装的那一版走,永远不会过期。 与本 skill 冲突时以它们为准。- 整应用从零生成不属于本 skill —— 用 hap-mcp-app-builder。