@deveco-test/hmos-deveco-cli 0.3.0-TD.1.2-alpha1 → 0.3.0-TD.1.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (15) hide show
  1. package/README.md +63 -955
  2. package/SKILL.md +29 -86
  3. package/THIRD-PARTY-LICENSES +1085 -44
  4. package/dist/cli.js +139 -111
  5. package/dist/internal/doc-init-background.js +65 -1
  6. package/docs.zip +0 -0
  7. package/index.zip +0 -0
  8. package/package.json +19 -9
  9. package/scripts/install-better-sqlite3.mjs +51 -0
  10. package/scripts/install-jieba-wasm.mjs +47 -0
  11. package/scripts/lib/better-sqlite3-vendor.mjs +128 -0
  12. package/scripts/lib/cli-data-dir.mjs +44 -0
  13. package/scripts/lib/doc-init-log-path.mjs +15 -0
  14. package/scripts/lib/jieba-wasm-vendor.mjs +102 -0
  15. package/scripts/postinstall.mjs +22 -1
package/README.md CHANGED
@@ -2,32 +2,35 @@
2
2
  <h1>DevEco CLI</h1>
3
3
  <p>一个面向 HarmonyOS 应用开发的统一命令行入口。</p>
4
4
  <p>
5
- <a href="https://www.npmjs.com/package/@deveco/deveco-cli"><img src="https://img.shields.io/npm/v/@deveco/deveco-cli.svg" alt="NPM Version" /></a>
6
- <a href="https://www.npmjs.com/package/@deveco/deveco-cli"><img src="https://img.shields.io/npm/dm/@deveco/deveco-cli.svg" alt="NPM Downloads" /></a>
5
+ <a href="https://www.npmjs.com/package/@deveco-test/hmos-deveco-cli"><img src="https://img.shields.io/npm/v/@deveco/deveco-cli.svg" alt="NPM Version" /></a>
6
+ <a href="https://www.npmjs.com/package/@deveco-test/hmos-deveco-cli"><img src="https://img.shields.io/npm/dm/@deveco-test/hmos-deveco-cli.svg" alt="NPM Downloads" /></a>
7
7
  <a href="https://nodejs.org/"><img src="https://img.shields.io/badge/Node.js-%3E%3D18-green.svg" alt="Node.js" /></a>
8
- <img src="https://img.shields.io/badge/platform-macOS%20%7C%20Windows%20%7C%20Linux-blue.svg" alt="Platform" />
9
- <a href="https://developer.huawei.com/consumer/cn/download/"><img src="https://img.shields.io/badge/DevEco%20Studio-%3E%3D6.0.0-orange.svg" alt="DevEco Studio" /></a>
10
- <img src="https://img.shields.io/badge/Command%20Line%20Tools-%3E%3D26.0.0-orange.svg" alt="Command Line Tools" />
8
+ <img src="https://img.shields.io/badge/platform-HarmonyOS-blue.svg" alt="Platform" />
9
+ </a>
11
10
  <a href="./LICENSE"><img src="https://img.shields.io/badge/license-MIT-green.svg" alt="License" /></a>
12
11
  </p>
13
12
  </div>
14
13
 
15
- `DevEco CLI` 将 `DevEco Studio` 工具链统一封装为一个 `CLI`，内置 `ohpm`、`hvigor`、`hdc`、`emulator`、`hilog`，同时集成 HarmonyOS 技能安装、项目脚手架、本地 HarmonyOS 文档检索和 `MCP` 服务。
14
+ `DevEco CLI` 将 `DevEco Studio` 工具链统一封装为一个 `CLI`，内置 `ohpm`、`hvigor`、`hdc`、`hilog`，同时集成 HarmonyOS 技能安装、项目脚手架、本地 HarmonyOS 文档检索和 `MCP` 服务。
16
15
 
17
16
 
18
17
  ## 快速开始
19
18
 
20
19
  ### 前置要求
21
20
 
22
- - 操作系统为 `macOS` 、 `Windows` 或 `Linux`（需配置对应环境变量）
23
- - Node.js >= 18，推荐使用22及以上版本
24
- - [DevEco Studio](https://developer.huawei.com/consumer/cn/download/) >= 6.0.0 或 [Command Line Tools](https://developer.huawei.com/consumer/cn/download/) >= 26.0.0
25
- - **macOS**：必须安装在 `~/Applications` 或 `/Applications` 目录下。
21
+ - 操作系统为 `HarmonyOS`
22
+ - 安装 Command Line Tool 工具
23
+ - 配置环境变量：
24
+ ```bash
25
+ export COMMAND_LINE_TOOL_PATH=path/to/deveco_tools
26
+ export PATH=$PATH:path/to/deveco_tools/node/bin
27
+ ```
28
+
26
29
 
27
30
  ### 安装
28
31
 
29
32
  ```bash
30
- npm install -g @deveco/deveco-cli@latest
33
+ npm install -g @deveco-test/hmos-deveco-cli
31
34
  ```
32
35
 
33
36
  安装后可以通过以下命令更新到最新版本：
@@ -54,41 +57,6 @@ devecocli docs read harmonyos-guides/application-models/arkts-page-start-overvie
54
57
 
55
58
  更多命令和参数可通过 `devecocli --help` 或各子命令的 `--help` 查看。
56
59
 
57
- ## 环境变量
58
-
59
- `devecocli` 当需要使用非默认安装路径、多版本并存时固定选型，Command Line Tools或在Linux下运行时，可通过以下环境变量显式指定工具链根：
60
-
61
- | 名称 | 说明 |
62
- | ------------------------ | ------------------------------------------------------ |
63
- | `DEVECO_CLI_STUDIO_PATH` | 显式指定 DevEco Studio 安装根，优先级最高 |
64
- | `DEVECO_CLI_CLT_PATH` | 显式指定 Command Line Tools 安装根 |
65
-
66
- 完整优先级链：
67
-
68
- ```text
69
- DEVECO_CLI_STUDIO_PATH > DEVECO_CLI_CLT_PATH > Auto_Detect
70
- ```
71
-
72
- ### 平台与版本约束
73
-
74
- | 平台 | DevEco Studio Auto_Detect | Command Line Tools | 最低版本 |
75
- | ------- | --------------------------------------------- | ------------------ | ----------------------------- |
76
- | Windows | 支持 | 可选 | Studio `6.0.0` / CLT `26.0.0` |
77
- | macOS | 支持 | 可选 | 同上 |
78
- | Linux | 不支持 | 必选 | CLT `26.0.0` |
79
-
80
- ### 使用示例
81
-
82
- ```bash
83
- # 设置 DevEco Studio
84
- export DEVECO_CLI_STUDIO_PATH="/Applications/DevEco-Studio.app" （可带或不带尾部 Contents）
85
- devecocli device list
86
-
87
- # 设置 CLT
88
- export DEVECO_CLI_CLT_PATH=/opt/command-line-tools
89
- devecocli device list
90
- ```
91
-
92
60
  ## AI Agent 集成
93
61
 
94
62
  `DevEco CLI` 支持通过命令行将自身技能添加到 `Agent` 中。下面以 `opencode` 为例展示最短流程：
@@ -105,22 +73,15 @@ cd MyApp
105
73
  opencode
106
74
  ```
107
75
 
108
- 也支持 `atomcode`等 Agent，使用方式相同：
109
-
110
- ```bash
111
- # 给 atomcode 安装技能
112
- devecocli init --agent atomcode
113
- ```
114
-
115
76
  如果 `Agent` 不在 `--agent` 参数取值范围内，可使用 `--path` 参数进行添加，参考如下命令：
116
77
 
117
78
  ```bash
118
- devecocli init --path D:\work\ARKTS\NewData
79
+ devecocli init --path .\work\ARKTS\NewData
119
80
  ```
120
81
 
121
82
  进入 `Agent` 后可以直接描述任务，例如：
122
83
 
123
- - `Build this project in release mode and run it on my emulator`
84
+ - `Build this project in release mode and run it on my device`
124
85
  - `Tail the last error logs from this app`
125
86
  - `Check for syntax errors in src/main/ets/pages/Index.ets`
126
87
 
@@ -133,19 +94,11 @@ devecocli init --path D:\work\ARKTS\NewData
133
94
  | `devecocli check lint` | 检查代码规范并输出实践建议与报告 |
134
95
  | `devecocli run` | 安装并运行应用 |
135
96
  | `devecocli device list` | 查看当前连接设备 |
136
- | `devecocli emulator list` | 查看本地模拟器实例 |
137
- | `devecocli ui layout` | 导出设备屏幕上的 UI 节点树（布局、坐标、节点 ID） |
138
- | `devecocli ui window list` | 查看设备窗口列表（为 `ui layout` / `ui click` 等提供窗口 ID） |
139
- | `devecocli ui screenshot` | 对真机或模拟器执行 UI 截图 |
140
- | `devecocli ui click` | 点击指定坐标或节点 ID |
141
- | `devecocli ui swipe` | 自定义滑动（指定起点、终点和速度） |
142
- | `devecocli ui text` | 输入文本到焦点或指定位置 |
143
97
  | `devecocli log` | 查看 `hilog` 或崩溃日志 |
144
98
  | `devecocli docs search` | 搜索本地 HarmonyOS 文档 |
145
99
  | `devecocli init` | 安装内置技能或配置 `MCP` |
146
100
  | `devecocli skills` | 管理 HarmonyOS 技能市场中的技能 |
147
101
  | `devecocli signature generate` | 自动生成调试签名材料并配置到项目 |
148
- | `devecocli check compat` | 扫描源代码在两个 `SDK` 版本之间的 `API` 变更 |
149
102
 
150
103
  ## 命令集
151
104
 
@@ -174,9 +127,6 @@ Commands:
174
127
  run [options] Build and run the project on a connected device
175
128
  update Update deveco-cli to the latest version
176
129
  device Manage connected devices
177
- emulator Manage emulator instances
178
- auth Authentication commands (login, logout, status, team)
179
- ui Inspect and interact with UI on a connected device
180
130
  skills Manage HarmonyOS skills
181
131
  log [options] Obtain device application logs
182
132
  create [options] Scaffold a new HarmonyOS application project
@@ -216,12 +166,12 @@ devecocli init --agent <agents> --project <path> --path <path> --skill --mcp --f
216
166
  devecocli init -f # 安装或更新deveco-cli Skill
217
167
  devecocli init --skill
218
168
  devecocli init --agent agentname # agentname需替换为实际的智能体名称
219
- devecocli init --path D:\work\ARKTS\NewData -f
169
+ devecocli init --path /path/to/project -f
220
170
 
221
171
  # 配置MCP
222
172
  devecocli init --mcp
223
173
  devecocli init --mcp --agent agentname # agentname需替换为实际的智能体名称
224
- devecocli init --mcp --project D:\work\ARKTS\NewData -f
174
+ devecocli init --mcp --project /path/to/project -f
225
175
  ```
226
176
 
227
177
  ### `docs search`
@@ -241,7 +191,7 @@ devecocli docs search <keywords...> --catalog <name> --format <fmt> --limit <n>
241
191
  | keywords... | 必选，搜索关键词，多个关键词用空格隔开 |
242
192
  | --catalog | 可选，文档类别，取值包含`harmonyos-releases`（版本说明）、 `harmonyos-guides`（指南）、`harmonyos-references`（API参考）、`best-practices`（最佳实践）、`harmonyos-faqs`（FAQ）、`harmonyos-roadmap`（变更预告）、`all`（所有分类，默认） |
243
193
  | --format | 可选，控制输出格式，取值包括 `default` 、`json` ，默认为`default` ，输出结果包括文档ID、标题、文档的概括内容 |
244
- | --limit | 可选，设置搜索结果返回条数，默认为10 |
194
+ | --limit | 可选，设置搜索结果返回条数，默认为20 |
245
195
 
246
196
  **示例：**
247
197
 
@@ -323,56 +273,6 @@ devecocli create --project-path ./MyApp --app-name MyApp --bundle-name com.acme.
323
273
  devecocli create --app-name MyApp
324
274
  ```
325
275
 
326
- ### `auth login`
327
-
328
- 登录华为开发者账号，打开浏览器完成授权。
329
-
330
- **命令格式：**
331
-
332
- ```bash
333
- devecocli auth login
334
- ```
335
-
336
- **说明：**
337
-
338
- - 海外账户暂不支持
339
-
340
- ### `auth logout`
341
-
342
- 登出并清除本地存储的凭据
343
-
344
- **命令格式：**
345
-
346
- ```bash
347
- devecocli auth logout
348
- ```
349
-
350
- ### `auth status`
351
-
352
- 显示当前登录的用户
353
-
354
- **命令格式：**
355
-
356
- ```bash
357
- devecocli auth status
358
- ```
359
-
360
- ### `auth team list`
361
-
362
- 列出当前用户已加入的团队
363
-
364
- **命令格式：**
365
-
366
- ```bash
367
- devecocli auth team list
368
- ```
369
-
370
- **示例：**
371
-
372
- ```bash
373
- devecocli auth team list
374
- ```
375
-
376
276
  ### `build`
377
277
 
378
278
  编译并打包 HarmonyOS 工程或工程中的模块
@@ -416,80 +316,6 @@ devecocli build --product oversea --modules entry --build-mode release
416
316
  devecocli build clean
417
317
  ```
418
318
 
419
- ### `check compat`
420
-
421
- 基于 `DevEco Studio` 自带的 `apkanalyzer-apiscan` 插件，扫描源代码在两个 `SDK` 版本之间的 `API` 变更情况。
422
-
423
- **子命令：**
424
-
425
- | 子命令 | 说明 |
426
- | --- | --- |
427
- | `devecocli check compat` | 默认执行工程级扫描 |
428
- | `devecocli check compat --modules <m1> [m2...]` | 按模块扫描 |
429
- | `devecocli check compat <file1> [file2...]` | 按文件扫描（仅支持 `.ets`/`.c`/`.cpp`） |
430
- | `devecocli check compat versions` | 列出可用的目标 `SDK` 版本 |
431
-
432
- **命令格式：**
433
-
434
- ```bash
435
- devecocli check compat [files...] --source-version <ver> --target-version <ver> [--modules <m...>] [--format <default|csv|json>] [--output-path <path>] [--limit <n>]
436
- ```
437
-
438
- **参数：**
439
-
440
- | 参数名 | 说明 |
441
- | --- | --- |
442
- | `--source-version` | 必填，当前工程 `SDK` 版本 |
443
- | `--target-version` | 必填，目标 `SDK` 版本 |
444
- | `--modules` | 可选，指定扫描的模块（多个以空格分隔）。与文件参数互斥 |
445
- | `--format` | 可选，输出格式。`default`/`csv`/`json`。默认 `default`（控制台输出文本，文件输出 `csv`） |
446
- | `--output-path` | 可选，报告输出路径。目录或文件（扩展名必须与 `--format` 匹配） |
447
- | `--limit` | 可选，控制台显示的最大记录数，默认 `100` |
448
-
449
- **版本号说明：**
450
-
451
- - 可用版本可通过 `devecocli check compat versions` 查看
452
- - `zsh` 环境下版本号需用引号包裹（包含括号），例如 `"<source_version>"`、`"<target_version>"`
453
-
454
- **`compat versions` 参数：**
455
-
456
- | 参数名 | 说明 |
457
- | --- | --- |
458
- | `--format` | 可选，输出格式。`default` 或 `json`。默认 `default`（文本输出，每行一个版本号） |
459
-
460
- **格式与输出组合：**
461
-
462
- | 场景 | 允许的 `--format` | 行为 |
463
- | --- | --- | --- |
464
- | 控制台输出（无 `--output-path`） | `default` / `json` | `default` 输出文本表格，`json` 输出 `JSON` |
465
- | 文件输出（`--output-path <file>`，扩展名必须匹配 `--format`） | `default` / `csv` / `json` | `default`/`csv` 写 `.csv` 文件；`json` 写 `.json` 文件 |
466
- | 目录输出（`--output-path <dir>`，无扩展名） | `default` / `csv` / `json` | `default`/`csv` 生成 `apiChange-res{N}.csv`；`json` 生成 `apiChange-res{N}.json` |
467
-
468
- **示例：**
469
-
470
- ```bash
471
- # 工程级扫描，输出到控制台
472
- devecocli check compat --source-version "<source_version>" --target-version "<target_version>"
473
-
474
- # 输出 JSON 到控制台
475
- devecocli check compat --format json --source-version "<source_version>" --target-version "<target_version>"
476
-
477
- # 输出报告到目录（默认 csv）
478
- devecocli check compat --output-path ./report --source-version "<source_version>" --target-version "<target_version>"
479
-
480
- # 输出 JSON 报告到目录（生成 apiChange-res{N}.json）
481
- devecocli check compat --output-path ./report --format json --source-version "<source_version>" --target-version "<target_version>"
482
-
483
- # 输出报告到指定文件
484
- devecocli check compat --output-path ./report.json --format json --source-version "<source_version>" --target-version "<target_version>"
485
-
486
- # 文件级扫描
487
- devecocli check compat ./entry/src/main/ets/pages/Index.ets --source-version "<source_version>" --target-version "<target_version>"
488
-
489
- # 模块级扫描
490
- devecocli check compat --modules entry har1 --source-version "<source_version>" --target-version "<target_version>"
491
- ```
492
-
493
319
  ### `check lint`
494
320
 
495
321
  检查代码规范并输出实践建议与报告。
@@ -509,294 +335,20 @@ devecocli check lint [path]
509
335
  | `--fix` | 自动修复可修复的问题 |
510
336
  | `--incremental` | 仅检查 Git 未提交文件 |
511
337
  | `--product <name>` | `build-profile.json5` 中定义的 product，默认为 `default` |
512
- | `--format <default\|json>` | 完整报告格式；`default` 输出 Markdown，`json` 输出 JSON；要求 DevEco Studio ≥ 6.1.0 |
513
- | `--output-path <path>` | 完整报告文件或目录,目录形式会自动生成带时间戳的报告文件；要求 DevEco Studio ≥ 6.1.0 |
338
+ | `--format <default\|json>` | 完整报告格式；`default` 输出 Markdown，`json` 输出 JSON |
339
+ | `--output-path <path>` | 完整报告文件或目录；目录形式会自动生成带时间戳的报告文件 |
514
340
  | `--limit <number>` | 未指定 `--output-path` 时，限制终端显示的问题数量 |
515
341
 
516
- `emulator` 版本要求： DevEco Studio ≥ 6.1.0
517
-
518
- ### `emulator list`
519
-
520
- 查看模拟器实例
521
-
522
- **命令格式：**
523
-
524
- ```bash
525
- devecocli emulator list [--format <table|json>]
526
- ```
527
-
528
- **参数：**
529
-
530
- | 参数名 | 说明 |
531
- | --- | --- |
532
- | `--format` | 可选，控制终端输出格式，取值为 `table` 或 `json`，默认为 `table` |
533
-
534
- **示例：**
535
-
536
- ```bash
537
- devecocli emulator list
538
- devecocli emulator list --format json
539
- ```
540
-
541
- ### `emulator start`
542
-
543
- 启动模拟器。首次使用时，需要签署 HarmonyOS 软件许可与服务协议，具体请参考 `emulator license`
544
-
545
- **命令格式：**
546
-
547
- ```bash
548
- devecocli emulator start [names...]
549
- ```
550
-
551
- **参数：**
552
-
553
- | 参数名 | 说明 |
554
- | ----------- | ----------------------------------------- |
555
- | \[names...] | 必选，模拟器实例名称，多个名称用空格隔开。若名称中带有空格，则名称需要添加英文引号 |
556
-
557
- **示例：**
558
-
559
- ```bash
560
- devecocli emulator start Phone
561
- devecocli emulator start Phone1 Phone2
562
- ```
563
-
564
- **说明：**
565
-
566
- - `emulator start` 命令仅支持启动 `release` 版本的模拟器
567
-
568
- ### `emulator stop`
569
-
570
- 关闭模拟器
571
-
572
- **命令格式：**
573
-
574
- ```bash
575
- devecocli emulator stop [names...]
576
- ```
577
-
578
- **参数：**
579
-
580
- | 参数名 | 说明 |
581
- | ----------- | ----------------------------------------- |
582
- | \[names...] | 必选，模拟器实例名称，多个名称用空格隔开。若名称中带有空格，则名称需要添加英文引号 |
583
-
584
- **示例：**
585
-
586
- ```bash
587
- devecocli emulator stop Phone
588
- devecocli emulator stop 127.0.0.1:5555
589
- ```
590
-
591
- ### `emulator` 场景操作
592
-
593
- 控制运行中的模拟器实例，直接映射 DevEco Studio 内置 Emulator 公开命令行参数。新增场景控制命令要求 Emulator 7.0 或更高版本；低版本会直接提示升级。截图不属于模拟器场景操作，统一通过 `devecocli ui screenshot` 执行。
594
-
595
- **示例：**
596
-
597
- ```bash
598
- devecocli emulator shake --target Phone
599
- devecocli emulator power --target Phone
600
- devecocli emulator rotate left --target Phone
601
- devecocli emulator volume up --target Phone
602
- devecocli emulator fold half-open --target Phone
603
- devecocli emulator battery --target Phone --level 90
604
- devecocli emulator battery --target Phone --status charging
605
- devecocli emulator geolocation --target Phone --longitude 116.400244
606
- devecocli emulator scene outdoorRunning --target Phone
607
- devecocli emulator sensor --target Phone --heartrate 80
608
- ```
609
-
610
- **说明：**
611
-
612
- - `--target` 支持模拟器名称或 `127.0.0.1:<port>` 序列号。
613
- - `battery --level` 会自动查询模拟器当前充电状态：充电时取值范围为整数 `[0, 100]`，未充电时为 `[1, 100]`。
614
- - `battery --status` 取值为 `charging` 或 `discharging`。
615
- - `geolocation` 支持 `--longitude`、`--latitude`、`--altitude`、`--direction`。
616
- - `scene` 取值为 `outdoorRunning`、`outdoorCycling`、`drivingNavigation`。
617
- - `sensor` 支持 `--light-intensity`、`--humidity`、`--temperature`、`--steps`、`--heartrate`。
618
- - `fold <state>` 会根据目标模拟器的设备类型校验状态，设备与参数必须匹配：
619
-
620
- | 设备类型 | 支持的 `state` |
621
- | --- | --- |
622
- | `foldable` | `open`、`half-open`、`close` |
623
- | `2in1_foldable` | `open`、`vertical-open`、`half-open`、`close` |
624
- | `triplefold` | `single`、`double`、`triple`、`left-folded-right-half-folded`、`left-half-folded-right-expanded`、`left-expanded-right-folded`、`left-half-folded-right-folded`、`left-expanded-right-half-folded`、`left-half-folded-right-half-folded` |
625
-
626
- 校验以目标模拟器实际返回的 `deviceType` 为准。非上述三种设备类型以及不属于目标设备类型的状态会在命令下发前被拒绝。校验通过后，底层映射为 `Emulator -instance <name> -foldedState <state>`。
627
- - 设置 `DEVECO_CLI_DEBUG=1` 可查看底层命令映射，例如 `Emulator -instance <name> -shake`。
628
-
629
- ### `emulator create`
630
-
631
- 创建模拟器
632
-
633
- **命令格式：**
634
-
635
- ```bash
636
- devecocli emulator create <name> --device-type <type> --os-version <version> --force
637
- ```
638
-
639
- **参数：**
640
-
641
- | 参数名 | 说明 |
642
- | ------------- | ------------------------------------------------------------------------------------------------------------------------------- |
643
- | name | 必选，模拟器名称 |
644
- | --device-type | 必选，模拟器设备类型，支持 `phone` ， `foldable` ， `widefold` ， `triplefold` ， `tablet` ， `2in1` ， `2in1 foldable` ， `tv` ， `wearable` ，全小写 |
645
- | --os-version | 必选，模拟器镜像版本 |
646
- | --force | 可选，覆盖已有同名的模拟器 |
647
-
648
- **示例：**
649
-
650
- ```bash
651
- devecocli emulator create MyPhone --device-type phone --os-version "HarmonyOS 6.0.1(21)"
652
- ```
653
-
654
- ### `emulator delete`
655
-
656
- 创建模拟器
657
-
658
- **命令格式：**
659
-
660
- ```bash
661
- devecocli emulator delete <name>
662
- ```
663
-
664
- **参数：**
665
-
666
- | 参数名 | 说明 |
667
- | ---- | -------------- |
668
- | name | 必选，模拟器实例名称或序列号 |
669
-
670
- **示例：**
671
-
672
- ```bash
673
- devecocli emulator delete MyPhone
674
- ```
675
-
676
- ### `emulator image list`
677
-
678
- 查询模拟器镜像列表
679
-
680
- **命令格式：**
681
-
682
- ```bash
683
- devecocli emulator image list --device-type <type> --all --format <format>
684
- ```
685
-
686
- **参数：**
687
-
688
- | 参数名 | 说明 |
689
- | ------------- | -------------------------------------------------------------------------------------------------------------------------- |
690
- | --device-type | 可选，模拟器设备类型，支持 `phone` ， `foldable` ， `widefold` ， `triplefold` ， `tablet` ， `2in1` ， `2in1 foldable` ， `tv` ， `wearable` |
691
- | --all | 可选，查询已下载和未下载的所有镜像 |
692
- | --format | 可选，控制输出格式，取值为 `table` 或 `json` ，默认为 `table` |
693
-
694
- **示例：**
695
-
696
- ```bash
697
- devecocli emulator image list
698
- devecocli emulator image list --all
699
- devecocli emulator image list --device-type phone
700
- devecocli emulator image list --format json
701
- ```
702
-
703
- ### `emulator image download`
704
-
705
- 下载模拟器镜像。首次使用时，需要签署 HarmonyOS `SDK` 许可协议，具体请参考 `emulator license`
706
-
707
- **命令格式：**
708
-
709
- ```bash
710
- devecocli emulator image download --device-type <type> --os-version <version> --force
711
- ```
712
-
713
- **参数：**
714
-
715
- | 参数名 | 说明 |
716
- | ------------- | ------------------------------------------------------------------------------------------------------------------------------- |
717
- | --device-type | 必选，模拟器设备类型，支持 `phone` ， `foldable` ， `widefold` ， `triplefold` ， `tablet` ， `2in1` ， `2in1 foldable` ， `tv` ， `wearable` ，全小写 |
718
- | --os-version | 必选，模拟器镜像版本 |
719
- | --force | 可选，覆盖已有的模拟器镜像 |
720
-
721
- **示例：**
722
-
723
- ```bash
724
- devecocli emulator image download --device-type phone --os-version "HarmonyOS 6.0.1(21)" --force
725
- ```
726
-
727
- **说明：**
728
-
729
- - `emulator image download` 命令仅支持下载 `release` 版本的模拟器镜像
730
-
731
- ### `emulator image remove`
732
-
733
- 删除模拟器镜像
734
-
735
- **命令格式：**
736
-
737
- ```bash
738
- devecocli emulator image remove --device-type <type> --os-version <version>
739
- ```
740
-
741
- **参数：**
742
-
743
- | 参数名 | 说明 |
744
- | ------------- | ------------------------------ |
745
- | --device-type | 必选，模拟器设备类型，与下载镜像的device-type一致 |
746
- | --os-version | 必选，模拟器镜像版本，与下载镜像的os-version一致 |
747
-
748
- **示例：**
749
-
750
- ```bash
751
- devecocli emulator image remove --device-type phone --os-version "HarmonyOS 6.0.1(21)"
752
- ```
753
-
754
- ### `emulator license view`
755
-
756
- 查看协议文本（只读）
757
-
758
- **命令格式：**
759
-
760
- ```bash
761
- devecocli emulator license view
762
- ```
763
-
764
- ### `emulator license`
765
-
766
- 交互式查看并接受协议。打印完整协议文本后提示 y/N 确认。使用模拟器需要同意 HarmonyOS 软件许可与服务协议，下载镜像需要同意 HarmonyOS `SDK` 许可协议。若已同意则直接提示已接受。非交互终端下会报错，请改用 `emulator license accept`
767
-
768
- **命令格式：**
769
-
770
- ```bash
771
- devecocli emulator license
772
- ```
773
-
774
- ### `emulator license accept`
775
-
776
- 非交互式同意模拟器所有协议，直接写入同意记录，跳过协议展示和确认提示。适用于自动化脚本、CI 或非交互终端环境。若已同意则直接提示已接受
777
-
778
- **命令格式：**
779
-
780
- ```bash
781
- devecocli emulator license accept
782
- ```
783
-
784
342
  ### `device list`
785
343
 
786
- 查询所有已连接的设备，包括真机设备和运行中的模拟器
344
+ 查询所有已连接的设备
787
345
 
788
346
  **命令格式：**
789
347
 
790
348
  ```bash
791
- devecocli device list [--format <table|json>]
349
+ devecocli device list
792
350
  ```
793
351
 
794
- **参数：**
795
-
796
- | 参数名 | 说明 |
797
- | --- | --- |
798
- | --format | 可选，输出格式。可选值：`table`、`json`，默认 `table` |
799
-
800
352
  ### `device view`
801
353
 
802
354
  查询已连接的设备的详细信息，包括设备序列号、设备名称、设备类型、 `OS` 版本等
@@ -804,7 +356,7 @@ devecocli device list [--format <table|json>]
804
356
  **命令格式：**
805
357
 
806
358
  ```bash
807
- devecocli device view [--target <serialOrName>] [--format <table|json>]
359
+ devecocli device view --target <serialOrName>
808
360
  ```
809
361
 
810
362
  **参数：**
@@ -812,7 +364,6 @@ devecocli device view [--target <serialOrName>] [--format <table|json>]
812
364
  | 参数名 | 说明 |
813
365
  | ----------- | ------------------------------------- |
814
366
  | -t，--target | 可选，目标设备名称或序列号。多设备缺省时，会列出所有已连接设备序列号和名称 |
815
- | --format | 可选，输出格式。可选值：`table`、`json`，默认 `table` |
816
367
 
817
368
  **示例：**
818
369
 
@@ -820,342 +371,11 @@ devecocli device view [--target <serialOrName>] [--format <table|json>]
820
371
  devecocli device view
821
372
  devecocli device view --target 127.0.0.1:5555
822
373
  devecocli device view -t "My Device Name"
823
- devecocli device view -t 127.0.0.1:5555 --format json
824
- ```
825
-
826
- ### `ui screenshot`
827
-
828
- 对真机或模拟器执行 UI 截图。
829
-
830
- **命令格式：**
831
-
832
- ```bash
833
- devecocli ui screenshot --device <name|serial> --display <displayId> --path <path>
834
- ```
835
-
836
- **参数：**
837
-
838
- | 参数 | 说明 | 默认值 |
839
- | ------------------------ | ------------------------ | ---------- |
840
- | --device \<name\|serial> | 真机或模拟器名称/序列号；多设备时必填 | 单设备自动选择 |
841
- | --display \<displayId> | 目标屏幕 ID，可选 | 默认屏幕 |
842
- | --path \<path> | 必填，文件夹路径或 PNG 文件路径；支持相对于当前目录的路径，目录必须存在且可写，目标文件不能已存在 | 无 |
843
-
844
- **示例：**
845
-
846
- ```bash
847
- mkdir -p screenshots
848
- devecocli ui screenshot --device Phone --path ./screenshots
849
- devecocli ui screenshot --device Phone --display 0 --path ./screenshots/phone.png
850
- ```
851
-
852
- **说明：**
853
-
854
- - `ui screenshot` 支持真机和模拟器。
855
- - 仅有一个可用设备时可省略 `--device`，多个设备同时连接时必须指定。
856
- - `--path` 可以使用相对于当前目录的路径。可以指定已存在的文件夹并自动生成 PNG 文件名，也可以指定完整的 PNG 文件路径；不会自动创建目录或覆盖已有文件。
857
- - 截图能力统一通过 `ui screenshot` 提供，不放在模拟器场景操作命令中。
858
- - 截图统一使用 `hdc shell snapshot_display` 和 `hdc file recv` 实现；设置 `DEVECO_CLI_DEBUG=1` 可查看实际执行命令。
859
-
860
- ### `ui click`
861
-
862
- 点击指定坐标或节点 ID 的中心位置。
863
-
864
- **命令格式：**
865
-
866
- ```bash
867
- devecocli ui click [x] [y] --device <name|serial> --id <id> --window <windowId>
868
- ```
869
-
870
- **参数：**
871
-
872
- | 参数 | 说明 |
873
- | --- | --- |
874
- | `[x] [y]` | 可选，目标坐标。缺省时需配合 `--id` 使用 |
875
- | --device \<name\|serial> | 目标设备，多设备时必填 |
876
- | --id \<id> | 节点 ID，自动解析为中心坐标。不可与 `[x] [y]` 同时使用 |
877
- | --window \<windowId> | 目标窗口 ID，需与 `--id` 配合使用 |
878
-
879
- **示例：**
880
-
881
- ```bash
882
- devecocli ui click 100 200
883
- devecocli ui click 100 200 --device Phone
884
- devecocli ui click --id submit_button
885
- devecocli ui click --id submit_button --window main_window
886
- ```
887
-
888
- ### `ui doubleclick`
889
-
890
- 双击指定坐标或节点 ID 的中心位置。
891
-
892
- **命令格式：**
893
-
894
- ```bash
895
- devecocli ui doubleclick [x] [y] --device <name|serial> --id <id> --window <windowId>
896
- ```
897
-
898
- **参数：**
899
-
900
- | 参数 | 说明 |
901
- | --- | --- |
902
- | `[x] [y]` | 可选，目标坐标。缺省时需配合 `--id` 使用 |
903
- | --device \<name\|serial> | 目标设备，多设备时必填 |
904
- | --id \<id> | 节点 ID，自动解析为中心坐标。不可与 `[x] [y]` 同时使用 |
905
- | --window \<windowId> | 目标窗口 ID，需与 `--id` 配合使用 |
906
-
907
- **示例：**
908
-
909
- ```bash
910
- devecocli ui doubleclick 100 200
911
- devecocli ui doubleclick 100 200 --device Phone
912
- devecocli ui doubleclick --id photo_thumb
913
- devecocli ui doubleclick --id photo_thumb --window main_window
914
- ```
915
-
916
- ### `ui longclick`
917
-
918
- 长按指定坐标或节点 ID 的中心位置。
919
-
920
- **命令格式：**
921
-
922
- ```bash
923
- devecocli ui longclick [x] [y] --device <name|serial> --id <id> --window <windowId>
924
- ```
925
-
926
- **参数：**
927
-
928
- | 参数 | 说明 |
929
- | --- | --- |
930
- | `[x] [y]` | 可选，目标坐标。缺省时需配合 `--id` 使用 |
931
- | --device \<name\|serial> | 目标设备，多设备时必填 |
932
- | --id \<id> | 节点 ID，自动解析为中心坐标。不可与 `[x] [y]` 同时使用 |
933
- | --window \<windowId> | 目标窗口 ID，需与 `--id` 配合使用 |
934
-
935
- **示例：**
936
-
937
- ```bash
938
- devecocli ui longclick 100 200
939
- devecocli ui longclick 100 200 --device Phone
940
- devecocli ui longclick --id menu_item
941
- devecocli ui longclick --id menu_item --window main_window
942
- ```
943
-
944
- ### `ui swipe`
945
-
946
- 自定义滑动（指定起点、终点和速度）。
947
-
948
- **命令格式：**
949
-
950
- ```bash
951
- devecocli ui swipe <x1> <y1> <x2> <y2> --device <name|serial> --speed <n>
952
- ```
953
-
954
- **参数：**
955
-
956
- | 参数 | 说明 |
957
- | --- | --- |
958
- | `<x1> <y1> <x2> <y2>` | 必选，起点和终点坐标 |
959
- | --device \<name\|serial> | 目标设备，多设备时必填 |
960
- | --speed \<n> | 可选，滑动速度（像素/秒），范围 `200` ~ `40000` |
961
-
962
- **示例：**
963
-
964
- ```bash
965
- devecocli ui swipe 100 500 100 200
966
- devecocli ui swipe 100 500 100 200 --device Phone
967
- devecocli ui swipe 100 500 100 200 --speed 1000
968
- ```
969
-
970
- ### `ui fling`
971
-
972
- 快速滑动（Fling）。
973
-
974
- **命令格式：**
975
-
976
- ```bash
977
- devecocli ui fling <x1> <y1> <x2> <y2> --device <name|serial> --speed <n>
978
- ```
979
-
980
- **参数：**
981
-
982
- | 参数 | 说明 |
983
- | --- | --- |
984
- | `<x1> <y1> <x2> <y2>` | 必选，起点和终点坐标 |
985
- | --device \<name\|serial> | 目标设备，多设备时必填 |
986
- | --speed \<n> | 可选，滑动速度（像素/秒），范围 `200` ~ `40000` |
987
-
988
- **示例：**
989
-
990
- ```bash
991
- devecocli ui fling 100 800 100 200
992
- devecocli ui fling 100 800 100 200 --device Phone
993
- devecocli ui fling 100 800 100 200 --speed 3000
994
- ```
995
-
996
- ### `ui drag`
997
-
998
- 拖拽操作。
999
-
1000
- **命令格式：**
1001
-
1002
- ```bash
1003
- devecocli ui drag <x1> <y1> <x2> <y2> --device <name|serial> --speed <n>
1004
- ```
1005
-
1006
- **参数：**
1007
-
1008
- | 参数 | 说明 |
1009
- | --- | --- |
1010
- | `<x1> <y1> <x2> <y2>` | 必选，起点和终点坐标 |
1011
- | --device \<name\|serial> | 目标设备，多设备时必填 |
1012
- | --speed \<n> | 可选，滑动速度（像素/秒），范围 `200` ~ `40000` |
1013
-
1014
- **示例：**
1015
-
1016
- ```bash
1017
- # 拖拽操作
1018
- devecocli ui drag 100 500 100 200
1019
- devecocli ui drag 100 500 100 200 --device Phone
1020
- devecocli ui drag 100 500 100 200 --speed 1500
1021
- ```
1022
-
1023
- ### `ui dircfling`
1024
-
1025
- 向指定方向快速滑动。
1026
-
1027
- **命令格式：**
1028
-
1029
- ```bash
1030
- devecocli ui dircfling <direction> --device <name|serial>
1031
- ```
1032
-
1033
- **参数：**
1034
-
1035
- | 参数 | 说明 |
1036
- | --- | --- |
1037
- | `<direction>` | 必选，方向，取值为 `up`, `down`, `left`, `right` |
1038
- | --device \<name\|serial> | 目标设备，多设备时必填 |
1039
-
1040
- **示例：**
1041
-
1042
- ```bash
1043
- devecocli ui dircfling up
1044
- devecocli ui dircfling down --device Phone
1045
- devecocli ui dircfling left
1046
- devecocli ui dircfling right
1047
374
  ```
1048
375
 
1049
- **与 `ui swipe` 的区别：**
1050
-
1051
- - `ui swipe` 需要指定精确的起点和终点坐标，支持自定义速度，适用于特定区域滑动。
1052
- - `ui dircfling` 仅需指定方向，使用系统默认速度，适用于页面滚动或列表快速滑动。
1053
-
1054
- ### `ui text`
1055
-
1056
- 输入文本到当前焦点、指定坐标或指定节点位置。
1057
-
1058
- **命令格式：**
1059
-
1060
- ```bash
1061
- devecocli ui text <text> [x] [y] --device <name|serial> --id <id> --window <windowId>
1062
- ```
1063
-
1064
- **参数：**
1065
-
1066
- | 参数 | 说明 |
1067
- | --- | --- |
1068
- | `<text>` | 必选，待输入的文本 |
1069
- | `[x] [y]` | 可选，目标坐标 |
1070
- | --device \<name\|serial> | 目标设备，多设备时必填 |
1071
- | --id \<id> | 节点 ID，自动解析为中心坐标。不可与 `[x] [y]`同时使用 |
1072
- | --window \<windowId> | 目标窗口 ID，需与 `--id` 配合使用 |
1073
-
1074
- **示例：**
1075
-
1076
- ```bash
1077
- devecocli ui text "Hello World"
1078
- devecocli ui text "Hello World" --device Phone
1079
- devecocli ui text "Hello World" 100 200
1080
- devecocli ui text "Hello World" --id search_box
1081
- devecocli ui text "Hello World" --id search_box --window main_window
1082
- ```
1083
-
1084
- ### `ui layout`
1085
-
1086
- 导出设备屏幕上的 UI 节点树，输出每个节点的类型、节点 ID、坐标边界 `[left,top,right,bottom]`、文本及可交互标志（`clickable` / `longClickable` / `scrollable` / `checkable`）。
1087
-
1088
- **命令格式：**
1089
-
1090
- ```bash
1091
- devecocli ui layout --device <name|serial> --id <id> --window <windowId> --all-windows --depth <n> --format <fmt> --mode <full|simplified>
1092
- ```
1093
-
1094
- **参数：**
1095
-
1096
- | 参数名 | 说明 |
1097
- | --- | --- |
1098
- | --device \<name\|serial> | 目标设备，多设备时必填 |
1099
- | --id \<id> | 节点 ID，筛选树中匹配节点（仅输出匹配节点，不带子节点，强制 JSON）。不可与未筛选的全树输出同时视为列表查询 |
1100
- | --window \<windowId> | 目标窗口 ID，与 `--all-windows` 互斥 |
1101
- | --all-windows | 包含所有窗口，与 `--window` 互斥 |
1102
- | --depth \<n> | 树深度限制，`0`=不限制（默认），`1`=仅根，`2`=根+子节点 |
1103
- | --format | 输出格式，`default` 或 `json`，默认 `default` |
1104
- | --mode | 输出模式：`full`=完整原始树；`simplified`（默认）=折叠无 ID、无文本、无可交互标志的包装节点 |
1105
-
1106
- **示例：**
1107
-
1108
- ```bash
1109
- devecocli ui layout
1110
- devecocli ui layout --device Phone
1111
- devecocli ui layout --device Phone --format json
1112
- devecocli ui layout --mode full --depth 2
1113
- devecocli ui layout --id submit_button
1114
- devecocli ui layout --window 15 --format json
1115
- ```
1116
-
1117
- **说明：**
1118
-
1119
- - `--mode simplified`（默认）会折叠无 `id`、无 `text`、无任何可交互标志的包装节点，使输出聚焦于有意义的可操作节点；根节点始终保留。`--depth` 在折叠后截断。
1120
- - `--id` 用于按节点 ID 查询，返回所有匹配节点（`children` 置空），常配合 `ui click --id` / `ui text --id` 定位坐标。
1121
- - 节点 `bounds` 为 `[left, top, right, bottom]`，`ui click --id` 等交互命令据此取中心坐标点击。
1122
- - `--window` 的窗口 ID 可通过 `devecocli ui window list` 获取。
1123
-
1124
- ### `ui window list`
1125
-
1126
- 查看设备上的窗口列表，输出窗口 ID、名称、PID、所属屏幕 ID 及是否聚焦。为 `ui layout --window`、`ui click --window` 等命令提供窗口 ID。
1127
-
1128
- **命令格式：**
1129
-
1130
- ```bash
1131
- devecocli ui window list --device <name|serial> --format <fmt> --all
1132
- ```
1133
-
1134
- **参数：**
1135
-
1136
- | 参数名 | 说明 |
1137
- | --- | --- |
1138
- | --device \<name\|serial> | 目标设备，多设备时必填 |
1139
- | --format | 输出格式，`default` 或 `json`，默认 `default` |
1140
- | --all | 显示包含系统窗口在内的所有窗口；缺省时仅显示应用窗口（`type === 1`） |
1141
-
1142
- **示例：**
1143
-
1144
- ```bash
1145
- devecocli ui window list
1146
- devecocli ui window list --device Phone
1147
- devecocli ui window list --format json
1148
- devecocli ui window list --all
1149
- ```
1150
-
1151
- **说明：**
1152
-
1153
- - 聚焦窗口在 `default` 格式下高亮显示。
1154
- - 缺省时仅列出应用窗口；加 `--all` 可查看系统窗口，用于排查多窗口场景。
1155
-
1156
376
  ### `run`
1157
377
 
1158
- 构建应用后，将应用安装到真机设备或模拟器上，并启动执行
378
+ 构建应用后，将应用安装到设备上，并启动执行
1159
379
 
1160
380
  **命令格式：**
1161
381
 
@@ -1165,18 +385,16 @@ devecocli run --module <module> --device <device> --product <product> --build-mo
1165
385
 
1166
386
  **参数：**
1167
387
 
1168
- | 参数名 | 说明 |
1169
- | ------------ |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
1170
- | --module | 可选，模块名称。如需指定模块的 `target` 信息，使用 `module@target` 形式。当工程中只有一个可运行模块（ `entry` / `feature` / `shared` ）时，可缺省 |
1171
- | --device | 设备名称或设备序列号，单设备时可选，多设备时必选 |
1172
- | --product | 可选，产品的名称，默认为 `default` |
1173
- | --build-mode | 可选，构建模式名称，默认为 `debug` |
1174
- | --ability | 可选，待启动的 `Ability` ，默认：模块 `module.json5` 中的`mainElement` |
1175
- | --uninstall | 可选，安装前先卸载已有应用 |
1176
- | --skip-build | 可选，跳过构建操作，直接安装应用 。\*\*说明：\*\*使用该参数时，需确保对应模块已有构建产物 |
1177
- | --apply \<fileName\> | 可选，**快速增量部署**：仅重编改动文件 → signed hqf → `bm quickfix -a -f -o` 安装 → 重启，比全量 `run` 快。`<fileName>` 是工程 `.hvigor/` 目录下的**纯文件名**（调用方把清单写到此目录，文件名做安全校验防穿越）；内容为本轮改动的源文件路径清单（每行一个相对工程根路径；`#`/空行忽略；`.ets`/`.ts`/`.cpp`/资源文件；changeFileList 增量累积，只需列本轮改的，历史文件自动保留）。模块从清单路径自动识别（无需 `--module`）。**前提**：DevEco Studio ≥6.1.1（hvigor `assembleDevHqf` 支持，低于拒绝并提示升级）；先 `devecocli run` 全量构建部署一次（生成 buildConfig.json 缓存）；**没生效排查**：检查 `<module>/build/config/buildConfig.json` 有无内容（空/无 = 没跑过 `devecocli run`）；**失败兜底**：直接 `devecocli run` |
1178
- | --hotreload [action] | 可选，**热重载 watch 会话**（须作为**后台进程**启动，该进程持久持有到 hvigor daemon 的 socket）：以热重载模式构建 hap（`hotReload=true debuggable=true`）、部署+拉起应用，然后进程自身连 socket 到 daemon 发 `CommonBuild assembleHap --hot-reload-build --watch` 并**保持连接**，保活 daemon 的 watch worker（rollup watch）供 `--hotreload-apply` 复用。进程常驻（onBuildOutput 流式到其 stdout）。**热重载调试结束必须 kill 此后台进程**（否则 watch worker/daemon 泄漏）；`stop` 同时关闭 hvigor daemon。用法：后台起 `devecocli run --module <m> --hotreload`，等 `.hotreload-mode` marker（或 stdout 出现 "watch session active"）即就绪，再跑 `--hotreload-apply`；结束 kill 后台进程 + `--hotreload stop` |
1179
- | --hotreload-apply \<fileName\> | 可选，**热重载（不重启应用）**：读取 `.hvigor/<fileName>` 改动清单（格式与 `--apply` 相同），开**短连接** socket 到 daemon（由后台 `--hotreload` 进程保活），发 `CommonBuild assembleDevHqf --hot-compile` → watch worker 增量 hot 编译改动 `.ets`/`.ts` 为 abc（HotReloadArkTS；输出/报错经 WatchLog 实时流式），再**手搓** pack+sign：`app_packing_tool.jar` 打包 + `hap-sign-tool.jar` 签名（DevEco material 密码经 `DecipherUtil` 解密），最后 `bm quickfix -a -f -o` 安装，**应用不重启即生效**。**前提**：后台 `--hotreload` 进程在跑（持有 watch 会话）；超时即 watch 会话没活，重启后台 `--hotreload`。**范围（重要）**：热重载目标是**单个模块**（`--module` 必填，目标可为 entry/hsp/feature；`har` 依赖并入、OK）；**`feature`/`hsp` 依赖模块**（非目标）的改动不支持热重载（检测并 warn，需全量 `devecocli run` 重部署）；资源/native 改动需全量 run。编译报错经 WatchLog 路由到后台 `--hotreload` 进程、落盘 **`.hvigor/hotreload-watch.log`**（+其 stdout），apply 失败时读该文件把报错打出来（~15s 超时快速失败）。**`.hvigor/` 产物**：`.hvigor/<fileName>`=改动清单（入参）、`.hvigor/hotreload-watch.log`=watch 会话的 onBuildOutput/编译报错（后台进程写，可读/可删）。 |
388
+ | 参数名 | 说明 |
389
+ | ------------ | ------------------------------------------------------------------------------------------------------ |
390
+ | --module | 可选，模块名称。如需指定模块的 `target` 信息，使用 `module@target` 形式。当工程中只有一个可运行模块（ `entry` / `feature` / `shared` ）时，可缺省 |
391
+ | --device | 设备名称或设备序列号，单设备时可选，多设备时必选 |
392
+ | --product | 可选，产品的名称，默认为 `default` |
393
+ | --build-mode | 可选，构建模式名称，默认为 `debug` |
394
+ | --ability | 可选，待启动的 `Ability` ，默认：模块 `module.json5` 中的`mainElement` |
395
+ | --uninstall | 可选，安装前先卸载已有应用 |
396
+ | --skip-build | 可选，跳过构建操作，直接安装应用 。\*\*说明：\*\*使用该参数时，需确保对应模块已有构建产物 |
397
+ | --apply \<fileName\> | 可选，**快速增量部署**：仅重编改动文件 → signed hqf → `bm quickfix -a -f -o` 安装 → 重启，比全量 `run` 快。`<fileName>` 是工程 `.hvigor/` 目录下的**纯文件名**（调用方把清单写到此目录，文件名做安全校验防穿越）；内容为本轮改动的源文件路径清单（每行一个相对工程根路径；`#`/空行忽略；`.ets`/`.ts`/`.cpp`/资源文件；changeFileList 增量累积，只需列本轮改的，历史文件自动保留）。模块从清单路径自动识别（无需 `--module`）。**前提**：先 `devecocli run` 全量构建部署一次（生成 buildConfig.json 缓存）；**没生效排查**：检查 `<module>/build/config/buildConfig.json` 有无内容（空/无 = 没跑过 `devecocli run`）；**失败兜底**：直接 `devecocli run` |
1180
398
 
1181
399
  **示例：**
1182
400
 
@@ -1188,9 +406,6 @@ devecocli run --product oversea --module entry --ability EntryAbility
1188
406
  devecocli run --build-mode release
1189
407
  devecocli run --uninstall
1190
408
  devecocli run --apply changes.txt
1191
- devecocli run --hotreload
1192
- devecocli run --hotreload stop
1193
- devecocli run --hotreload-apply changes.txt
1194
409
  ```
1195
410
 
1196
411
  ### `log`
@@ -1330,7 +545,7 @@ devecocli skills remove --skill skillname --agent agentname # skillname需替
1330
545
 
1331
546
  ### `serve mcp`
1332
547
 
1333
- 启动本地 `MCP` 服务。智能体配置 `MCP` 服务后，可通过 `MCP` 协议调用下方列出的代码分析与语言特性工具。不同智能体平台配置 `MCP` 服务的界面不一样，一个智能体平台的配置示例如下。
548
+ 启动本地 `MCP` 服务。智能体配置 `MCP` 服务后，可通过 `MCP` 协议调用 `ArkTS` / `C++` 语法检查工具。不同智能体平台配置 `MCP` 服务的界面不一样，一个智能体平台的配置示例如下。
1334
549
  推荐通过 `devecocli init --mcp` 自动配置
1335
550
 
1336
551
  ```bash
@@ -1344,9 +559,8 @@ devecocli skills remove --skill skillname --agent agentname # skillname需替
1344
559
  "mcp"
1345
560
  ],
1346
561
  "environment":{
1347
- "PROJECT_PATH": "D:\\code\\sample_project", // 工程路径
562
+ "PROJECT_PATH": "/path/to/project", // 工程路径
1348
563
  "NODE_MAX_OLD_SPACE_SIZE": "8192", // 可选，设置内部node进程最大的老生代内存大小，默认为8192
1349
- "DEVECO_PATH": "D:\\Application\\DevEco Studio" // 可选，Deveco Studio的路径
1350
564
  },
1351
565
  "enbale": true
1352
566
  }
@@ -1354,137 +568,6 @@ devecocli skills remove --skill skillname --agent agentname # skillname需替
1354
568
  }
1355
569
  ```
1356
570
 
1357
- #### MCP 工具
1358
-
1359
- `deveco-mcp` 服务遵循 [MCP](https://modelcontextprotocol.io) 规范，通过 `tools/list` 暴露工具、由模型经 `tools/call` 调用。每个工具由**名称**、**描述**和 **JSON Schema 入参**定义；返回值为 `content` 文本数组，`isError: true` 表示执行错误。
1360
-
1361
- **工具总览：**
1362
-
1363
- | 工具名 | 用途 | 支持语言 |
1364
- | --- | --- | --- |
1365
- | `check` | 静态语法分析，返回结构化诊断信息 | ArkTS、C/C++ |
1366
- | `hover` | 获取指定位置的悬浮信息（类型、文档） | ArkTS、C/C++ |
1367
- | `definition` | 查找符号定义位置 | ArkTS、C/C++ |
1368
- | `declaration` | 查找符号声明位置（ArkTS 中可能与定义不同） | ArkTS、C/C++ |
1369
- | `references` | 查找符号在全工程中的所有引用 | ArkTS、C/C++ |
1370
- | `implementation` | 查找符号的实现（如接口实现） | ArkTS、C/C++ |
1371
- | `workspaceSymbol` | 按名称在全工程搜索符号 | ArkTS、C/C++ |
1372
- | `documentSymbol` | 获取单文件的符号树（函数、类、变量及范围） | ArkTS、C/C++ |
1373
- | `callHierarchy` | 查询函数调用关系（incoming=调用方，outgoing=被调用方） | ArkTS 双向、C/C++ 仅 incoming |
1374
- | `restart` | 原地重启（重置状态 + 重新 sync/init），不杀进程、客户端不断开；ERROR 态可用 | ArkTS、C/C++（可按 target 单选） |
1375
-
1376
- **可用性说明：**
1377
-
1378
- - `check` 与 `restart` 始终注册；其余 7 个语言特性工具仅在 DevEco Studio 附带标准 LSP 服务入口（`standardIndex/index.js`）时注册，老版本将不暴露这些工具。
1379
- - 所有语言特性工具需项目进入 `READY` 状态（`ohpm install` + `hvigor sync` + LSP 初始化完成）后才可用；未就绪时返回 `please retry in N seconds`，模型可稍后重试。`restart` 例外：它正是用于把 server 从 `ERROR` 态拉回，调用后返回"约 10 秒后重试"，后台异步重置并重新 sync/init。
1380
- - C/C++ 工具需要工程包含 C++ 模块；无 C++ 代码时返回 `No C++ code`。
1381
- - 支持的文件扩展名：ArkTS 为 `.ets`；C/C++ 为 `.c` `.cc` `.cpp` `.cxx` `.c++` `.h` `.hh` `.hpp` `.hxx` `.h++` `.ipp` `.ixx` `.inl` `.inc` `.tpp`。
1382
- - 不属于当前工程的路径会被拒绝。
1383
-
1384
- **入参定义：**
1385
-
1386
- ##### `check`
1387
-
1388
- 对传入的源文件进行静态语法分析并返回诊断信息，支持 ArkTS 与 C/C++ 在同一次调用中混合传入。
1389
-
1390
- | 参数 | 类型 | 必选 | 说明 |
1391
- | --- | --- | --- | --- |
1392
- | `files` | string[] | 是 | 待检查的源文件路径列表，相对工程根目录，至少 1 个 |
1393
-
1394
- ##### `hover` / `definition` / `declaration` / `references` / `implementation`
1395
-
1396
- 位置类语言特性，共享同一入参结构。返回该位置符号的类型/文档信息、定义/声明位置、引用列表或实现列表。
1397
-
1398
- | 参数 | 类型 | 必选 | 说明 |
1399
- | --- | --- | --- | --- |
1400
- | `file` | string | 是 | 源文件路径，相对工程根目录，支持 `.ets` 与 C/C++ 扩展名 |
1401
- | `line` | number | 是 | 行号，0-based |
1402
- | `character` | number | 是 | 列号（字符偏移），0-based |
1403
-
1404
- ##### `workspaceSymbol`
1405
-
1406
- 按名称在全工程搜索符号，无需打开具体文件。
1407
-
1408
- | 参数 | 类型 | 必选 | 说明 |
1409
- | --- | --- | --- | --- |
1410
- | `query` | string | 是 | 符号名称或片段，非空 |
1411
-
1412
- ##### `documentSymbol`
1413
-
1414
- 获取单个文件的符号树，适合文件概览、结构化拆解和大文件切片。
1415
-
1416
- | 参数 | 类型 | 必选 | 说明 |
1417
- | --- | --- | --- | --- |
1418
- | `file` | string | 是 | 源文件路径，相对工程根目录，支持 `.ets` 与 C/C++ 扩展名 |
1419
-
1420
- ##### `callHierarchy`
1421
-
1422
- 查询某位置函数的调用关系。
1423
-
1424
- | 参数 | 类型 | 必选 | 说明 |
1425
- | --- | --- | --- | --- |
1426
- | `file` | string | 是 | 源文件路径，相对工程根目录，支持 `.ets` 与 C/C++ 扩展名 |
1427
- | `line` | number | 是 | 行号，0-based |
1428
- | `character` | number | 是 | 列号（字符偏移），0-based |
1429
- | `direction` | enum | 是 | `incoming`=谁调用了该函数；`outgoing`=该函数调用了谁。ArkTS 支持双向，C/C++（clangd）仅 `incoming` |
1430
-
1431
- ##### `restart`
1432
-
1433
- 原地重启 MCP server：重置双侧状态并重新 sync/init（ohpm install + hvigor sync + compileNative + LSP 握手），不杀进程、客户端连接保持。用于 sync/init 失败导致 server 停在 `ERROR` 态时（免去退出并重开 agent）。fire-and-forget：立即返回"约 10 秒后重试"，重置在后台异步进行。**注意：`restart` 仅在修复根因后用于恢复，不能修复错误的工程配置。若重启后再次失败，说明是持久性配置问题（oh-package.json5/build-profile.json5 无效、ohpm install 或 hvigor sync 失败、SDK 版本不符等），不要循环调用 `restart`，应请用户排查并修复工程后再重试。**
1434
-
1435
- | 参数 | 类型 | 必选 | 说明 |
1436
- | --- | --- | --- | --- |
1437
- | `target` | enum | 否 | 重启哪一侧：`arkts`（ArkTS ace-server）、`cpp`（C++ clangd）、`all`（双侧，默认）。省略等同 `all` |
1438
-
1439
- ### `serve lsp`
1440
-
1441
- 启动本地 `LSP` 语言服务。智能体配置 `LSP` 服务后，可通过 `LSP` 协议获取代码补全、跳转定义、悬浮提示、引用查找、诊断等语言特性。当前支持 `ArkTS`和 `clangd`。
1442
-
1443
- ```bash
1444
- {
1445
- "lsp": {
1446
- "ArkTS": {
1447
- "command": [
1448
- "devecocli",
1449
- "serve",
1450
- "lsp",
1451
- "--arkts"
1452
- ],
1453
- "extensions": [
1454
- ".ets"
1455
- ]
1456
- },
1457
- "clangd": {
1458
- "command": [
1459
- "devecocli",
1460
- "serve",
1461
- "lsp",
1462
- "--cpp"
1463
- ],
1464
- "extensions": [
1465
- ".c",
1466
- ".cpp",
1467
- ".cc",
1468
- ".cxx",
1469
- ".h",
1470
- ".hpp",
1471
- ".hxx",
1472
- ".hh"
1473
- ]
1474
- }
1475
- }
1476
- }
1477
- ```
1478
-
1479
- **参数：**
1480
-
1481
- | 参数名 | 说明 |
1482
- | --- | --- |
1483
- | `--arkts` | 与 `--cpp` 二选一，启动 ArkTS 语言服务（ace-server） |
1484
- | `--cpp` | 与 `--arkts` 二选一，启动 C/C++ 语言服务（clangd） |
1485
- | `--project-path <path>` | 可选，工程根路径，默认为当前工作目录 |
1486
- | `--auto-detect` | 可选，当前目录向下查找工程根（检查当前目录自身及其子目录，最多 3 层子目录）；适用于 `--arkts` 和 `--cpp`；指定了 `--project-path` 则忽略 |
1487
-
1488
571
  ### `signature generate`
1489
572
 
1490
573
  自动生成调试签名材料（包括p12密钥库、csr证书请求文件、p7b配置文件、cer证书文件），并将签名配置写入项目的 `build-profile.json5` 中。
@@ -1525,7 +608,32 @@ devecocli signature generate --help
1525
608
 
1526
609
  ## 常见问题
1527
610
 
1528
- [FAQ](https://gitcode.com/openharmony-sig/deveco-cli/wiki/FAQ.md)
611
+ ### 如何本地推包运行
612
+
613
+ 当没有真机设备连接时，可以通过无线调试实现自连，在本地推包运行应用：
614
+
615
+ **步骤 1：开启无线调试**
616
+
617
+ 在设备上进入：系统 → 开发者选项 → 无线调试，开启无线调试功能。
618
+
619
+ **步骤 2：配置 hdc 命令路径**
620
+
621
+ 将 hdc 工具路径添加到环境变量：
622
+
623
+ ```bash
624
+ export PATH=$PATH:path/to/deveco_tools/sdk/default/openharmony/toolchains
625
+ ```
626
+
627
+ **步骤 3：通过 hdc 命令自连**
628
+
629
+ 使用 hdc 命令连接设备的 IP 和端口：
630
+
631
+ ```bash
632
+ hdc tconn IP:端口
633
+ ```
634
+
635
+ 连接成功后，即可使用 `devecocli run` 命令推包运行应用。
636
+
1529
637
 
1530
638
  ## 开发
1531
639