README_zh.md
1# **bm工具命令组件**
2
3## 简介
4
5bm是用来方便开发者调试的一个工具。bm工具被hdc工具封装，进入hdc shell命令后，就可以使用bm工具。
6
7
8## 目录
9
10```
11foundation/bundlemanager/bundle_tool
12├── frameworks # bm工具服务框架代码
13└── test # 测试目录
14```
15
16### bm工具命令
17| 命令 | 描述 |
18| ------- | ---------- |
19| help | 帮助命令，显示bm支持的命令信息 |
20| install | 安装命令，用来安装应用|
21| uninstall | 卸载命令，用来卸载应用|
22| dump | 查询命令，用来查询应用的相关信息|
23| clean | 清理命令，用来清理应用的缓存和数据 |
24| enable | 使能命令，用来使能应用 |
25| disable | 禁用命令，用来禁用应用 |
26| get | 获取udid命令，用来获取设备的udid |
27| quickfix | 快速修复相关命令，用来执行补丁相关操作，如补丁安装、补丁查询 |
28| dump-dependencies | 查询应用依赖的模块信息 |
29| dump-shared | 查询应用间HSP应用信息 |
30| dump-overlay | 打印overlay应用的的overlayModuleInfo |
31| dump-target-overlay | 打印目标应用的所有关联overlay应用的overlayModuleInfo |
32#### 帮助命令
33| 命令 | 描述 |
34| ------- | ---------- |
35| bm help | 显示bm工具的能够支持的命令信息 |
36
37* 示例
38```Bash
39# 显示帮助信息
40bm help
41```
42#### 安装命令
43命令可以组合，下面列出部分命令。
44| 命令 | 描述 |
45| ----------------------------------- | -------------------------- |
46| bm install -h | 显示install支持的命令信息 |
47| bm install -p <file-path> | 安装应用，支持指定路径和多个hap、hsp同时安装 |
48| bm install -p <file-path> -u <user-id> |给指定用户安装一个应用 |
49| bm install -r -p <file-path> | 覆盖安装一个应用 |
50| bm install -r -p <file-path> -u <user-id> | 给指定用户覆盖安装一个应用 |
51| bm install -r -p <file-path> -u <user-id> -w <waitting-time> | 安装时指定bm工具等待时间，最小的等待时长为180s，最大的等待时长为600s, 默认缺省为5s |
52| bm install -s <hsp-dir-path> | 安装应用间共享库， 每个路径目录下只能存在一个hsp或者一个与hsp相匹配的代码签名文件 |
53| bm install -p <file-path> -s <hsp-dir-path> | 同时安装使用方应用和其依赖的应用间共享库 |
54| bm install -p <file-path> -v <code-signature-file-path>| 安装应用，同时指定应用的代码签名文件路径，安装时，会校验应用的代码。此时，不支持多个hap、hsp批量安装 |
55
56* 示例
57```Bash
58# 安装一个hap
59bm install -p /data/app/ohosapp.hap
60# 覆盖安装一个hap
61bm install -p /data/app/ohosapp.hap -r
62# 安装一个应用间共享库
63bm install -s xxx.hsp
64# 同时安装多个应用间共享库
65bm install -s xxx.hsp yyy.hsp
66# 同时安装使用方应用和其依赖的应用间共享库
67bm install -p aaa.hap -s xxx.hsp yyy.hsp
68# 安装应用时进行代码签名校验
69bm install -p aaa.hap -v xxx.sig
70bm install -p aaa.hsp -v xxx.sig
71# 安装应用间的共享库，同时进行代码签名校验, /data/test/目录下只存在aaa.hsp和匹配的xxx.sig
72bm install -s /data/test/
73```
74#### 卸载命令
75命令可以组合，下面列出部分命令。-u未指定情况下，默认为所有用户。
76| 命令 | 描述 |
77| ----------------------------- | ------------------------ |
78| bm uninstall -h | 显示uninstall支持的命令信息 |
79| bm uninstall -n <bundle-name> | 通过指定包名卸载应用 |
80| bm uninstall -n <bundle-name> -u <user-id>| 通过指定包名和用户卸载应用 |
81| bm uninstall -n <bundle-name> -m <moudle-name> | 通过指定包名卸载应用的一个模块 |
82| bm uninstall -s <hsp-dir-path> -n <bundle-name> | 卸载指定的shared bundle |
83| bm uninstall -s <hsp-dir-path> -n <bundle-name> -v <version-code> | 卸载指定的shared bundle的指定版本 |
84
85* 示例
86```Bash
87# 卸载一个应用
88bm uninstall -n com.ohos.app
89# 卸载应用的一个模块
90bm uninstall -n com.ohos.app -m com.ohos.app.MainAbility
91# 卸载一个shared bundle
92bm uninstall -s -n com.ohos.example
93# 卸载一个shared bundle的指定版本
94bm uninstall -s -n com.ohos.example -v 100001
95```
96#### 查询命令
97命令可以组合，下面列出部分命令。-u未指定情况下，默认为所有用户。
98| 命令 | 描述 |
99| ---------- | -------------------------- |
100| bm dump -h | 显示dump支持的命令信息 |
101| bm dump -a | 查询系统已经安装的所有应用 |
102| bm dump -n <bundle-name> | 查询指定包名的详细信息 |
103| bm dump -n <bundle-name> -s | 查询指定包名下的快捷方式信息 |
104| bm dump -n <bundle-name> -d <device-id> | 跨设备查询包信息 |
105| bm dump -n <bundle-name> -u <user-id> | 查询指定用户下指定包名的详细信息 |
106| bm dump-shared -h | 显示dump-shared支持的命令信息 |
107| bm dump-shared -a | 查询系统中已安装所有共享库 |
108| bm dump-shared -n <bundle-name> | 查询指定共享库包名的详细信息 |
109| bm dump-dependencies -h | 显示bm dump-dependencies支持的命令信息 |
110| bm dump-dependencies -n <bundle-name> -m <moudle-name> | 查询指定应用指定模块依赖的共享库信息 |
111
112* 示例
113```Bash
114# 显示所有已安装的包名
115bm dump -a
116# 显示该应用的详细信息
117bm dump -n com.ohos.app
118# 显示所有已安装共享库包名
119bm dump-shared -a
120# 显示该共享库的详细信息
121bm dump-shared -n com.ohos.lib
122# 显示指定应用指定模块依赖的共享库信息
123bm dump-dependencies -n com.ohos.app -m entry
124```
125#### 清理命令
126-u未指定情况下，默认为当前活跃用户。
127| 命令 | 描述 |
128| ---------- | -------------------------- |
129| bm clean -h | 显示clean支持的命令信息 |
130| bm clean -n <bundle-name> -c | 清除指定包名的缓存数据 |
131| bm clean -n <bundle-name> -d | 清除指定包名的数据目录 |
132| bm clean -n <bundle-name> -c -u <user-id> | 清除指定用户下包名的缓存数据 |
133| bm clean -n <bundle-name> -d -u <user-id> | 清除指定用户下包名的数据目录 |
134
135* 示例
136```Bash
137# 清理该应用下的缓存数据
138bm clean -n com.ohos.app -c
139# 清理该应用下的用户数据
140bm clean -n com.ohos.app -d
141```
142#### 使能命令
143-u未指定情况下，默认为当前活跃用户。
144| 命令 | 描述 |
145| ---------- | -------------------------- |
146| bm enable -h | 显示enable支持的命令信息 |
147| bm enable -n <bundle-name> | 使能指定包名的应用 |
148| bm enable -n <bundle-name> -a <ability-name> | 使能指定包名下的元能力模块 |
149| bm enable -n <bundle-name> -u <user-id>| 使能指定用户和包名的应用 |
150
151* 示例
152```Bash
153# 使能该应用
154bm enable -n com.ohos.app
155```
156#### 禁用命令
157-u未指定情况下，默认为当前活跃用户。
158| 命令 | 描述 |
159| ---------- | -------------------------- |
160| bm disable -h | 显示disable支持的命令信息 |
161| bm disable -n <bundle-name> | 禁用指定包名的应用 |
162| bm disable -n <bundle-name> -a <ability-name> | 禁用指定包名下的元能力模块 |
163| bm disable -n <bundle-name> -u <user-id>| 禁用指定用户和包名下的应用 |
164
165* 示例
166```Bash
167# 禁用该应用
168bm disable -n com.ohos.app
169```
170#### 获取udid命令
171| 命令 | 描述 |
172| ---------- | -------------------------- |
173| bm get -h | 显示get支持的命令信息 |
174| bm get -u | 获取设备的udid |
175
176* 示例
177```Bash
178# 获取设备的udid
179bm get -u
180```
181
182#### 快速修复命令
183| 命令 | 描述 |
184| ---------- | -------------------------- |
185| bm quickfix -h | 显示quickfix支持的命令信息 |
186| bm quickfix -a -f <file-path> | 执行补丁安装命令 |
187| bm quickfix -q -b <bundle-name> | 根据包名查询补丁包信息 |
188
189* 示例
190```Bash
191# 根据包名查询补丁包信息
192bm quickfix -q -b <bundle-name>
193```
194
195#### 获取overlay应用的Overlay信息命令
196| 命令 | 描述 |
197| ---------- | -------------------------- |
198| bm dump-overlay -h | 显示dump-overlay支持的命令信息 |
199| bm dump-overlay -b <bundle-name> | 获取指定应用的所有OverlayModuleInfo信息 |
200| bm dump-overlay -b <bundle-name> -m <module-name> | 根据指定的包名和module名查询OverlayModuleInfo信息 |
201| bm dump-overlay -b <bundle-name> -t <target-module-name> | 根据指定的包名和目标module名查询OverlayModuleInfo信息 |
202
203* 示例
204```Bash
205* 示例
206# 根据包名来获取overlay应用com.ohos.app中的所有OverlayModuleInfo信息
207bm dump-overlay -b com.ohos.app
208
209# 根据包名和module来获取overlay应用com.ohos.app中overlay module为entry的所有OverlayModuleInfo信息
210bm dump-overlay -b com.ohos.app -m entry
211
212# 根据包名和module来获取overlay应用com.ohos.app中目标module为feature的所有OverlayModuleInfo信息
213bm dump-overlay -b com.ohos.app -m feature
214```
215
216#### 获取目标应用的Overlay信息命令
217| 命令 | 描述 |
218| ---------- | -------------------------- |
219| bm dump-target-overlay -h | 显示dump-target-overlay支持的命令信息 |
220| bm dump-target-overlay -b <bundle-name> | 获取指定目标应用的所有OverlayBundleInfo信息 |
221| bm dump-target-overlay -b <bundle-name> -m <module-name> | 根据指定的目标应用的包名和module名查询OverlayModuleInfo信息 |
222
223* 示例
224```Bash
225* 示例
226# 根据包名来获取目标应用com.ohos.app中的所有关联的OverlayBundleInfo信息
227bm dump-target-overlay-b com.ohos.app
228
229# 根据包名和module来获取目标应用com.ohos.app中目标module为entry的所有关联的OverlayModuleInfo信息
230bm dump-target-overlay -b com.ohos.app -m entry
231
232```
233
234## 相关仓
235
236[bundlemanager_bundle_framework](https://gitee.com/openharmony/bundlemanager_bundle_framework)
237