dsh-hdc-bridge

DSH 原生鸿蒙开发助手：hdc 设备闭环调试（看设备 → 截图 → 看图 → 改码 → 装包 → 验证）＋ 官方优先版本化知识层（离线 Tier-1 随包 + SDK 机读 + 官方文档检索）＋ 可选官方 DevEco CLI 构建/签名通道。 A DSH-native HarmonyOS dev assistant: the hdc device loop (inspect → screenshot → view → fix → install → verify), an official-first version-classified knowledge layer (offline Tier-1 bundled + SDK-accurate reads + official docs search), and an optional official DevEco CLI build/sign backend.

定位

hdc_mcp 等 MCP 服务器已覆盖 hdc 能力层。本插件不重写 hdc 协议，直接复用本机 hdc 二进制（3.x），价值在 DSH 原生层：

• 会话内工具卡片与 read_image 原生闭环
• 按调用会话解析沙箱策略（与 pwsh 工具同款路线），截图写入 <workspace>/.dsh-hdc/screenshots/
• 结构化的失败上报（hdc 传输层退出码不可靠，插件用输出标记 + 落盘校验兜底）
• v0.7 起面板按官方 client 插件形态集成（边栏入口 + 浮动面板 + 官方主题），v0.9 补齐会话级编译、静态检查、部署与日志工具（switch_cwd / build_project / arkts_check / start_app / hdc_log）

截图 / Screenshots

浮动设备面板（点左侧边栏「鸿蒙」入口打开；设备列表 / 系统区 / 工具链徽章 / hilog 尾部，官方主题随深浅色自适应）：

工具

约定：所有工具失败不抛异常，统一返回业务值 { ok: false, error, hint }（error 为可读原因，hint 为修复指引）；成功返回带 ok: true 的结果对象。工具描述里同时给出 error 示例。这是本插件的显式约定（官方工具层允许抛 ToolFailure，本插件为面板/技能一致性选择返回值形式并在此声明）。

这份 README 是 dsh-hdc-bridge 的项目版使用手册。它不仅列出原始工具，还说明模型在真实鸿蒙工程中应如何编排调用、如何判断回退是否真的成功，以及安装本插件后新增的 DSH 能力边界。

安装 / Installation

# npm 安装 / install from npm
dsh plugin --profile <name> add dsh-hdc-bridge

# 或直接从 GitHub 安装（纯 JS、无构建步骤，无需授权 prepare）/ or install straight from GitHub (plain JS, no build step, no prepare grant needed)
dsh plugin --profile <name> add github:1na-ko/dsh-hdc-bridge

# 验证组合层，然后启动 / verify the composed layer, then boot
dsh --profile <name> --dump-config   # 确认出现 dsh-hdc-bridge 层 / confirms the dsh-hdc-bridge layer
dsh --profile <name>

环境要求

• DSH ≥ 0.1.7-rc.2（推荐 ≥ 0.2.0-rc.2，0.2.0-rc.2 已实测）：上游 0.2.0-rc.2 起把 ctx.shell.run() 换成 resolve() + execute()（句柄 result() 取结果）——新契约为准；0.1.5 及更早的旧线（run()）由兼容垫片接管，两条线都可用。两条 seam 都不存在的宿主会直接给出「seam 缺失」的明确报错，而不是误导性的 hdc not found
• HarmonyOS 设备/模拟器；真机需开发者模式 + USB 调试
• hdc 二进制自动探测（工具与面板共用同一套候选源）：显式 devecoPath / DEVECO_STUDIO_HOME / DEVECO_HOME / DEVECO_SDK_HOME → Windows 注册表（含 WOW6432Node）→ 非默认 DevEco/CLT SDK 根 → 默认安装根（apiVer 覆盖 default/10…18）→ PATH 回退（where.exe / Get-Command / which）；面板优先复用工具层已解析路径，两侧行为一致
• 截图查看需图像输入模型；纯文本模型可用 hdc_ui_dump 做文本化 UI 检查
• 可选后端 @deveco/deveco-cli（MIT）不随插件安装（插件零依赖，安装期不执行任何第三方脚本），工具链二选一：
  • 路线 A｜DevEco Studio：本机装 DevEco Studio ≥ 6.1.0（macOS/Windows）+ npm i -g @deveco/deveco-cli；
  • 路线 B｜独立 Command Line Tools：华为官方 zip 发行版（codelinter / hvigorw / ohpm / emulator / 内嵌 SDK，≥ 26.0.0，解压即用），下载自 developer.huawei.com/consumer/cn/download/command-line-tools-for-hmos，设置 DEVECO_CLI_CLT_PATH（或 COMMAND_LINE_TOOL_PATH）指向解压目录即可被自动识别；根识别支持 version.txt 与无 version.txt 的发行形态（HNP/系统集成包：以 sdk/default 布局为准，世代号取自 sdk/default/sdk-pkg.json）；Linux 主机仅支持此形态。
  • 未安装时相关工具全部优雅降级并给出安装指引；hms_setup 一眼可查当前 toolchainKind（studio / clt）。签名前需一次人工 devecocli auth login（浏览器 OAuth）
• 本机无任何工具链时仍可用：hdc_* 全部工具、设备面板与 Tier-1 离线知识层（随包内置）
• hms_api / hms_lint rules 直接读本机 DevEco Studio/SDK 安装（零再分发）；未装 Studio 时这两项降级并给出指引
• hms_knowledge 的 Tier-1 官方知识节选随包内置（28 篇约 1.7MB，CC-BY-4.0 逐字节选并附署名 + 逐文件溯源），离线可用，无需任何本机安装
• hms_api_change（check compat）需要更高版本的 DevEco Studio（实测 6.1.0.830 报"min required 26.0.0.810"）；不满足时工具返回官方错误原文 + 升级指引，并提示先用 hms_api 的 @since/@deprecated 版本知识

依赖与许可合规

• 本包零 npm 依赖（安装期不执行任何第三方脚本）；devecocli 为可选后端，需要时由用户自行安装（见上）
• 引用资源严格分四类并记录于 THIRD_PARTY_NOTICES.md（机器源 notices.json）：① 可选后端（devecocli，MIT，不随装——本机探测/PATH 使用）；② 随包内容（knowledge/ 官方文档逐字节选，CC-BY-4.0 署名 + 逐文件溯源）；③ 改写内容（deveco-cli 技能改编自官方 SKILL.md，MIT 版权声明保留）；④ 仅引用不分发（SDK .d.ts、codelinter 规则、harmony-next.skills 等——本机读取或链接指路）
• 发布前跑 npm run license-check 门禁：白名单校验（MIT/Apache-2.0/CC-BY-4.0/ISC/BSD/0BSD）、依赖声明与 notices 一致性、改写内容版权行存在性

权限与沙箱

• 工具按调用会话解析沙箱策略（会话 cwd 为工作区边界）
• 截图默认写入 <workspace>/.dsh-hdc/screenshots/，建议加入项目 .gitignore
• 若部署沙箱 runner 不可用（SandboxUnavailableError），按 DSH 规范对单条命令以更宽模式升级重试；hvigor 构建因其用户级缓存（~/.hvigor、npm 缓存）在工作区外，通常需要该升级
• devecocli 内部会派生管道 stdio 子进程（签名校验、hvigor fork）：在受限沙箱会话中会报 EPERM/误报"未签名"，工具透传官方错误原文并给出沙箱外执行指引（build/run/sign 官方本就标注 [Outside sandbox]）

实测矩阵

已知限制 / Known limitations

• snapshot_display 仅支持 .jpeg（API 10+ 实测；API 24 真机 2800×1840 已验证）
• 真机安装需签名 profile 绑定设备 UDID，否则报 9568332 install sign info inconsistent（应用签名问题，非插件问题）
• hdc 客户端对远端失败可能仍返回退出码 0，插件以输出标记 + 落盘校验兜底
• hms_lint check 的 JSON 报表依赖 CLI 的 --output-path（Studio ≥ 6.1 / CLT ≥ 26）：报表暂存在工作区 .dsh-hdc/lint/ 并读取后删除；旧版 CLI 仍按 stdout JSON 兼容解析
• arkts_check 的随包 checker 只识别 <root>/sdk/default/... 与 <root>/sdk/openharmony/... 两种 SDK 布局（CLT 实机布局即前者）；<root>/sdk/<api>/... 的社区变体需把 DEVECO_CLI_CLT_PATH/Studio 指到与布局匹配的根
• hvigorw 回退的 kind=js 入口（CLT 无 bin/ 时）必须由工具链自带 node 运行：CLT <root>/node，Studio <root>/tools/node，缺失时退回宿主 node
• hdc_shell 的命令跨三层解析（本机宿主 shell → hdc 参数拼接 → 设备端 sh），插件自 v0.8.1 起自动逐层转义保证保真（pwsh 与 POSIX 宿主一致）；命令中的其余 sh 元字符（双引号、$、; 等）按设备端 sh 原语义生效，请直接传入目标语义的合法命令- UI 输入实战经验（真机实测）：
  • 混合字符串（数字→字母→数字）注入时，IME 模式切换会稳定吞掉紧跟字母后的第一个字符；规避：分段输入 + hdc_ui_dump 校验 + 缺失字符单独补发
  • 软键盘会改变页面布局：每次点击/输入前使用最新 dump 的坐标，否则可能点到键盘区
  • 键盘可能遮住按钮：先 hdc_ui action=key key=Back 收起键盘，再按新坐标点击

模型调用手册

标准工程闭环

模型接手一个 HarmonyOS 工程时，按以下顺序调用：

1. switch_cwd 指向包含 build-profile.json5 的工程根目录。
2. hms_setup action=doctor 确认 DevEco Studio、SDK、JBR、hdc、devecocli 和目标 API。
3. hdc_log action=list_devices 或 hdc_list_targets 确认设备；多设备时保存返回的 preferred 或明确选择 target。
4. 修改 .ets 后调用 arkts_check。
5. 调用 build_project；需要全量重建时传 clean:true，该调用执行 clean → build → HAP 产物校验。
6. 需要安装、启动和 mission 证明时调用 hms_build action=run；只启动已有 HAP 时调用 start_app。
7. 用 hdc_ui_dump、hdc_ui_find、hdc_screenshot、hdc_hilog 或 hdc_crash 做设备侧验证。

不要把 build_project 的文字输出当作唯一成功依据；同时检查 ok、backend、artifactVerified、hapAfter 和真实设备状态。

典型 tool call

{"name":"switch_cwd","arguments":{"path":"E:\\ScribePad"}}

{"name":"hms_setup","arguments":{"action":"doctor"}}

{"name":"hdc_log","arguments":{"action":"list_devices"}}

{"name":"arkts_check","arguments":{}}

普通增量构建：

{"name":"build_project","arguments":{"clean":false,"product":"default","build_mode":"debug"}}

全量重建：

{"name":"build_project","arguments":{"clean":true,"product":"default","build_mode":"debug"}}

真实部署闭环：

{"name":"hms_build","arguments":{"action":"run","projectPath":"E:\\ScribePad","device":"192.168.1.11:12345"}}

成功时应看到 ok:true、stage:"start"、目标 target、HAP 路径和 missionVerified:true。只清理构建目录时使用 hms_build action=clean；它是 clean-only，不会自动重新 build。

start_app 的安全调用方式

start_app 不重新构建。未传 hvd 时只发现设备，不安装、不启动：

{"name":"start_app","arguments":{}}

模型应从返回的在线设备列表中选择目标，再显式调用：

{"name":"start_app","arguments":{"hvd":"192.168.1.11:12345"}}

可选参数是 ability、module、target。当 devecocli 的设备发现通道被 mojo 阻断时，主提示仍以 hdc 的真实在线设备为准，不再并列显示误导性的“未检测到可用设备”。

UI 观察 → 操作 → 验证

{"name":"hdc_ui_dump","arguments":{}}

{"name":"hdc_ui_find","arguments":{"text":"登录","exact":true}}

把 hdc_ui_find 返回的 center 坐标传给操作工具：

{"name":"hdc_ui","arguments":{"action":"tap","x":540,"y":1460}}

{"name":"hdc_ui","arguments":{"action":"input","text":"test@example.com"}}

每次键盘弹出、页面滚动或窗口改变后，都要重新 dump/find，不能复用旧坐标。键盘遮挡时先发送 {"action":"key","key":"Back"}。

截图、日志和崩溃

{"name":"hdc_screenshot","arguments":{}}

截图返回的本地 JPEG 路径交给 read_image。纯文本模型使用：

{"name":"hdc_hilog","arguments":{"lines":200,"tag":"PARAM"}}

{"name":"hdc_log","arguments":{"action":"collect","bundle":"com.example.scribepad","lines":300}}

{"name":"hdc_crash","arguments":{"kind":"all","bundleName":"com.example.scribepad","lines":80}}

新增能力速查

设备层（12 个工具）

hdc_list_targets 列出全量 hdc targets；hdc_connect 连接 TCP 设备；hdc_shell 执行设备 shell；hdc_screenshot 截图并拉回 JPEG；hdc_install 安装 HAP；hdc_hilog 读取 hilog；hdc_ui_dump 文本化 UI 层级树；hdc_ui_find 按文本/hint 查控件并计算中心点；hdc_ui 执行 tap、doubleTap、longPress、swipe、input、key；hdc_app 管理应用生命周期；hdc_crash 读取 faultlogger 崩溃；hdc_diag 诊断本机插件和沙箱状态。

官方工具链层（8 个工具）

hms_setup 汇总 hdc/Studio/SDK/devecocli/设备和三源 API 版本；hms_build 封装官方 build/run/sign/clean/status；hms_lint 提供本机 57+ 条规则、规则文档和官方 lint；hms_api 从本机 SDK .d.ts 读取模块、声明和 @since/@deprecated/@syscap；hms_knowledge 提供 28 篇离线官方知识；hms_docs 访问 devecocli 官方本地文档；hms_api_change 扫描 SDK 版本间破坏性变更；hms_emulator 控制模拟器和注入电量、GPS、传感器、折叠、旋转、运动场景等状态。

DevEco Code 编译层（5 个工具）

switch_cwd、build_project、arkts_check、start_app、hdc_log 是从 deveco-code-gitcode 对照移植的会话编译闭环。它们共享会话工程根目录、沿用官方参数命名，并在本插件层补充 hdc 设备过滤、HAP 产物校验、JBR 注入和结构化失败结果。

返回值契约

• hdc_log action=list_devices 返回 devices、全量 targets、preferred、preferredActive；COM 串口只保留在 targets。
• hms_build build 返回 backend、artifactVerified、hapBefore、hapAfter；没有真实 HAP 时不得 ok:true。
• hms_build run fallback 返回 stage、hap、bundleName、target、start.ok、missionVerified。
• build_project 返回 artifactStale、hapBefore、hapAfter、backend；clean:true 的 command 明确显示 clean → build。
• start_app 未传 hvd 时返回 availableDevices，只做发现；传入 hvd 后才允许部署和启动。
• 构建日志和 hms_build 输出会清除 ANSI 转义码；长输出按尾部截断，状态行保持在末尾可见。

知识查询纪律

涉及 ArkTS/API 时先确定目标 API 版本，再按以下优先级：

1. hms_api：本机 SDK 的机器可读声明和版本标签；
2. hms_knowledge：离线官方节选，适合概念和用法；
3. hms_docs：全量官方本地文档；
4. hms_api_change：跨版本破坏性变更；
5. hms_lint：本机官方规则验证。

示例：

{"name":"hms_api","arguments":{"action":"lookup","module":"@ohos.promptAction","name":"showToast"}}

{"name":"hms_knowledge","arguments":{"action":"search","keywords":"Navigation 路由"}}

{"name":"hms_lint","arguments":{"action":"rules","limit":10}}

面板与 REST

Web profile 注册以下路由：

• /api2/hdc-bridge/panel-state：设备、工具链、SDK/API 和面板状态；
• /api2/hdc-bridge/select：选择会话默认设备；
• /api2/hdc-bridge/screenshot.jpeg：当前目标截图；
• /api2/hdc-bridge/hilog：面板日志。

面板入口挂左侧边栏 sidebar.footer.action 槽位（折叠态图标 + 状态点 + 数量角标，展开态「鸿蒙」标签贴排）；点击经 ReactDOM portal 打开右上角浮动面板（可拖拽、八向缩放、收起、归位、× 关闭），样式使用 DSH 官方 --dsw-alias-* token 和 data-plugin-css 注入，随平台生命周期卸载。

工具链探测和沙箱

Windows 探测顺序为：显式路径/环境变量 → 注册表（含 WOW6432Node）→ PATH 反查 → 常见 DevEco Studio/SDK 目录。Studio 根目录继续用于定位 SDK API、JBR Java、hvigorw 和 hdc.exe。

构建、运行、签名、compat 等官方命令可能被 DSH 受限策略阻断。插件会返回 mojoFatal 或 outsideWorkspace，并在可行时切换到本地 hvigorw/hdc 回退；回退必须通过真实产物、安装结果和 mission 检查。所有插件管理的 hvigor 任务都会先在项目内的 .dsh-hvigor-tmp 设置 HVIGOR_USER_HOME 和 BUILD_CACHE_DIR（后者把 build.log 等项目缓存也收进隔离目录），首次运行时复用默认 hvigor home 已缓存的 wrapper/pnpm，执行 hvigorw --stop-daemon，再注入 DevEco Studio JBR 的 JAVA_HOME 和 bin 到 PATH，最后以 --no-daemon 执行，避免旧 daemon 缓存裸 java 环境导致 spawn java ENOENT（包括 app_packing_tool.jar / onDeviceTest 类任务）。停止旧 daemon 若被宿主权限策略拒绝不会阻断当前的无 daemon 任务；任务本身仍按真实退出码和产物校验判定成功。hms_emulator list 与 hms_api_change 的 JSON 通道为空时，包装层会重试宿主策略并回退到 devecocli emulator list / check compat versions 的纯文本输出（compat 回退合并 stderr 透传官方原文，且 Studio 低于 26.0.0.810 时由本地版本前置直接合成官方报错），成功路径也始终返回可读 output；hms_emulator list 先确保 hdc 已初始化，再在 hdc 有 Connected 模拟器目标时用 hdc 事实回填，start 会幂等轮询任意 Connected 模拟器目标（兼容 devecocli 的 status/state/isRunning 字段）到 running 才报成功。hms_build / build_project 返回体带 daemonStopped、javaHome、hvigorUserHome、buildCacheDir 诊断字段。签名 OAuth 仍需用户在宿主终端执行一次 devecocli auth login。

当前实测范围

Windows + DevEco Studio 6.1.1.300 + SDK API 24 + TCP 真机 192.168.1.11:12345 已验证：

• 25 个工具、5 个运行时 skill、4 个面板 REST 路由注册；
• switch_cwd、ArkTS 32 文件检查、设备首次发现和 preferred 回填；
• build_project(clean=true) 真实 clean → build → HAP 校验；
• hms_build clean/build/run 真实产物、安装、启动和 missionVerified:true；
• start_app 无 hvd 时列设备且不自动部署；
• build/run 输出 ANSI 清理；
• 离线知识 28 篇、hms_lint 57+ 规则索引和插件 smoke 回归。

仍需人工覆盖：面板 GUI 视觉逐态、签名 OAuth 成功路径、不同 Studio/SDK 版本；macOS 宿主经社区报告（issue #7）实测验证（SDK API 26，截图/dump 路径已修复）。

路线图

• DevEco CLI（devecocli）构建/签名封装（v0.4：可选后端 + hvigorw 降级）
• 官方优先版本化知识层（v0.4：SDK .d.ts + 官方文档检索 + 跨版本变更扫描 + 官方 lint 规则）
• 按 API 版本整理的官方知识节选随包内置（v0.5：hms_knowledge，28 个高频主题逐字节选，CC-BY-4.0 合规）
• 输入行设备面板（v0.6：Web 宿主 REST 数据通道 + 对话输入行入口）
• 深度优化 + 面板官方化（v0.7：全量回归 smoke、hdc-core/errors 拆分与 11 条错误码、hms_build 工作区预检、hms_emulator 模拟器控制、签名三类指引、Tier-1 扩至 28 篇；面板使用官方 client 槽位和主题 token，胶囊上方锚定展开）
• 上游整合移植（v0.9.0：吸收 PR #6——会话编译闭环五工具、运行时技能补全、emulator hdc 交叉校验、CLT 双形态；面板保持官方 client 形态）
• macOS 宿主路径兼容（v0.9.1：社区报告 + 实测验证，joinPath 化修复截图/dump 暂存路径；其余工具待完整实机回归）
• 统一 hdc 发现 + 支持独立 Command Line Tools（v0.10：面板/工具层单源探测、DEVECO_SDK_HOME 动态根、CLT >=26 双形态识别，SDK/hdc/hvigorw/codelinter 全链自动覆盖，Linux 仅 CLT 形态）
• 社区 issue 批次 #8-#13（DSH 0.2.0-rc.2 shell 契约迁移 + 双 seam 垫片、bash 宿主 CLI 探测与负缓存失效、无 version.txt 的 CLT 发现与世代门、构建产物判定与 hvigorw node 前缀、arkts_check CLT 回退、lint 报表落盘）

License

MIT