鸿蒙HarmonyOS-SDK管理使用指南

sdkmgr使用指导

sdkmgr（点击链接获取）是一个HarmonyOS SDK命令行管理工具，支持Windows、Mac、Linux三个平台。

sdkmgr支持查看、安装和卸载SDK组件，SDK组件包括API和工具链。

适用于DevEco Studio 3.1 Canary1（3.1.0.100）及以上版本。

sdkmgr命令行格式为：

sdkmgr <command> --[options] [<component>] 

command：包括list、install、uninstall、version、help。

options：可选配置参数，请参考options选项说明。

component：组件，支持的组件请使用list命令查看。

查看SDK组件

查看本地和远程组件命令格式如下：

sdkmgr list --[options] [<component>] 

查询SDK组件的示例如下所示：

• 查看所有组件的安装情况：

  sdkmgr list
  

  运行结果片段示例：

   Component                 | API Version | Version   | Stage   | Status        | Available Update------------------------- | ----------- | --------- | ------- | ------------- | ----------------previewer                 | 9           | 3.2.2.2   | Beta1   | Not Installed |system-image,phone_x86    | 9           | 3.1.0.106 | Beta1   | Not Installed |toolchains                | 9           | 3.2.2.2   | Beta1   | Not Installed |OpenHarmony/ets           | 9           | 3.2.2.6   | Beta1   | Not Installed |OpenHarmony/js            | 9           | 3.2.2.6   | Beta1   | Not Installed |...------------------------- | ----------- | --------- | ------- | ------------- | ----------------...------------------------- | ----------- | --------- | ------- | ------------- | ----------------ets                       | 7           | 3.0.0.5   | Release | Not Installed |java                      | 7           | 3.0.0.5   | Release | Not Installed |js                        | 7           | 3.0.0.5   | Release | Not Installed |...------------------------- | ----------- | --------- | ------- | ------------- | ----------------...system-image,phone_x86    | 6           | 2.0.0.211 | Release | Not Installed |...------------------------- | ----------- | --------- | ------- | ------------- | ----------------...------------------------- | ----------- | --------- | ------- | ------------- | ----------------emulator                  | 0           | 3.1.0.100 | Beta1   | Not Installed |------------------------- | ----------- | --------- | ------- | ------------- | ----------------
  

• 查看指定路径下所有组件的安装情况：

  sdkmgr list --sdk-directory="/data/sdk"
  

• 查看指定API Version版本的JS组件：

  sdkmgr list OpenHarmony/js:9
  

安装组件

安装一个或多个组件命令格式如下：

sdkmgr install --[options] <component1> [<component2>] 

安装组件的示例如下所示：

• 安装最新版本的JS组件：

  sdkmgr install OpenHarmony/js
  

• 安装API Version为9的JS组件：

  sdkmgr install OpenHarmony/js:9
  

• 安装API Version为7的JS组件：

  sdkmgr install js:7
  

• 同时安装API Version为9的JS组件和Native组件：

  sdkmgr install OpenHarmony/js:9 OpenHarmony/native:9
  

• 安装最新版本的JS组件，并指定SDK存储路径：

  sdkmgr install --sdk-directory="/data/sdk" OpenHarmony/js
  

• 安装最新版本的JS组件，需要使用http代理来安装，代理信息文件通过config参数进行指定：

  sdkmgr install OpenHarmony/js --config="/data/sdk/config.properties"
  

  其中，config参数指定的配置文件config.properties中包含代理服务器信息和组件存储路径。

  sdk-directory="/data/sdk"proxy-type=httpproxy=host:port
  

• 安装comp.txt中指定的组件，并安装到指定的目录。

  sdkmgr install --component-file="/data/sdk/comp.txt" --sdk-directory="/data/sdk"
  

  其中，comp.txt中包含的内容举例如下所示：

  OpenHarmony/ets:9OpenHarmony/js:9OpenHarmony/native:9toolchains
  

• 安装镜像：

  sdkmgr install system-image,phone_x86
  

• 安装模拟器：

  sdkmgr install emulator 
  

卸载组件

卸载一个或多个组件命令格式如下：

sdkmgr uninstall --[options] <component1> [<component2>]

卸载组件的示例如下所示：

• 卸载本地的JS组件，可以指定具体的API Version，如果不指定，则会卸载最高API Version的最新版本。

  sdkmgr uninstall OpenHarmony/js:9
  

• 同时卸载本地已安装的API Version为5的Java组件和JS组件版本。

  sdkmgr uninstall java:5 js:5
  

查看sdkmgr版本

查看sdkmgr版本号的命令格式为：

sdkmgr version | --version

查看sdkmgr帮助

查看sdkmgr帮助文档的命令格式为：

sdkmgr help | --help 

options选项说明

options是sdkmgr的可选配置参数，这些参数可以直接在命令行中执行外，还可以将这些参数配置到sdkmgr配置文件（sdkmgr工具默认配置文件路径为sdkmanager/conf/config.properties）中。

说明

config=、component-file=和accept-license参数只能在命令行中执行，不能写到配置文件中。

选项	说明
config=	sdkmgr配置文件存放目录，默认为sdkmanager/conf/config.properties。
sdk-directory=	指定存放组件的根目录，默认路径为sdkmgr工具根目录的上一级目录。
component-file=	指定一个文本文件，文件内容指定需要安装的组件。
node-home=	指定为Node.js所在的根目录。
proxy-type=<none | http | socks>	代理类型，取值为none或者http或者socks。
proxy=host:port	代理服务器的主机和端口。
accept-license	自动签署SDK License协议。
no-ssl-verify	访问HarmonyOS SDK下载路径时，是否进行HTTPS的证书校验，默认进行证书校验，设置该参数则会关闭证书校验。说明关闭证书校验，可能会带来安全风险，请谨慎使用。
debug	开启debug模式。

ohsdkmgr使用指导

ohsdkmgr（单击链接获取）是一个OpenHarmony SDK命令行管理工具，支持Windows、Mac、Linux三个平台。

ohsdkmgr支持查看、安装和卸载SDK组件，SDK组件包括API和工具链。

适用于DevEco Studio 3.1 Canary1（3.1.0.100）及以上版本。

ohsdkmgr命令行格式为：

ohsdkmgr <command> --[options] [<component>] 

command：包括list、install、uninstall、version、help。

options：可选配置参数，请参考options选项说明。

component：组件，支持的组件请使用list命令查看。

查看SDK组件

查看本地和远程组件命令格式如下：

ohsdkmgr list --[options] [<component>] 

查询SDK组件的示例如下所示：

• 查看所有组件的安装情况：

  ohsdkmgr list
  

  运行结果片段示例：

   Component  | API Version | Version  | Stage   | Status        | Available Update---------- | ----------- | -------- | ------- | ------------- | ----------------ets        | 9           | 3.2.10.6 | Beta5   | Not Installed |js         | 9           | 3.2.10.6 | Beta5   | Not Installed |native     | 9           | 3.2.10.6 | Beta5   | Not Installed |previewer  | 9           | 3.2.10.6 | Beta5   | Not Installed |toolchains | 9           | 3.2.10.6 | Beta5   | Not Installed |---------- | ----------- | -------- | ------- | ------------- | ----------------...---------- | ----------- | -------- | ------- | ------------- | ----------------
  

• 查看指定路径下所有组件的安装情况：

  ohsdkmgr list --sdk-directory="/data/sdk"
  

• 查看指定API Version版本的JS组件：

  ohsdkmgr list js:9
  

安装组件

安装一个或多个组件命令格式如下：

ohsdkmgr install --[options] <component1> [<component2>] 

安装组件的示例如下所示：

• 安装最新版本的JS组件：

  ohsdkmgr install js
  

• 安装API Version为9的JS组件：

  ohsdkmgr install js:9
  

• 同时安装API Version为9的JS组件和Native组件：

  ohsdkmgr install js:9 native:9
  

• 安装最新版本的JS组件，并指定SDK存储路径：

  ohsdkmgr install --sdk-directory="/data/sdk" js
  

• 安装最新版本的JS组件，需要使用http代理来安装，代理信息文件通过config参数进行指定：

  ohsdkmgr install js --config="/data/sdk/config.properties"
  

  其中，config参数指定的配置文件config.properties中包含代理服务器信息和组件存储路径。

  sdk-directory="/data/sdk"proxy-type=httpproxy=host:port
  

• 安装comp.txt中指定的组件，并安装到指定的目录。

  ohsdkmgr install --component-file="/data/sdk/comp.txt" --sdk-directory="/data/sdk"
  

  其中，comp.txt中包含的内容举例如下所示：

  ets:9js:9native:9toolchains
  

卸载组件

卸载一个或多个组件命令格式如下：

ohsdkmgr uninstall --[options] <component1> [<component2>]

卸载组件的示例如下所示：

• 卸载本地的JS组件，可以指定具体的API Version，如果不指定，则会卸载最高API Version的最新版本。

  ohsdkmgr uninstall js:9
  

• 同时卸载本地已安装的API Version为9的JS组件和Native组件版本。

  ohsdkmgr uninstall js:9 native:9
  

查看ohsdkmgr版本

查看ohsdkmgr版本号的命令格式为：

ohsdkmgr version | --version

查看ohsdkmgr帮助

查看ohsdkmgr帮助文档的命令格式为：

ohsdkmgr help | --help 

options选项说明

options是ohsdkmgr的可选配置参数，这些参数可以直接在命令行中执行外，还可以将这些参数配置到ohsdkmgr配置文件（ohsdkmgr工具默认配置文件路径为sdkmanager/conf/config.properties）中。

说明

config=、component-file=和accept-license参数只能在命令行中执行，不能写到配置文件中。

选项	说明
config=	ohsdkmgr配置文件存放目录，默认为sdkmanager/conf/config.properties。
sdk-directory=	指定存放组件的根目录，默认路径为ohsdkmgr工具根目录的上一级目录。
component-file=	指定一个文本文件，文件内容指定需要安装的组件。
node-home=	指定为Node.js所在的根目录。
proxy-type=<none | http | socks>	代理类型，取值为none或者http或者socks。
proxy=host:port	代理服务器的主机和端口。
accept-license	自动签署SDK License协议。
no-ssl-verify	访问OpenHarmony SDK下载路径时，是否进行HTTPS的证书校验，默认进行证书校验，设置该参数则会关闭证书校验。说明关闭证书校验，可能会带来安全风险，请谨慎使用。
debug	开启debug模式。