@ah-plugins/dsh-deveco-cli

使用示例

# 2. 给 opencode 在当前 HarmonyOS 项目配置 MCP
devecocli init --mcp --agent opencode --project ./MyApp

# 配置Skill
devecocli init -f   # 安装或更新deveco-cli Skill
devecocli init --skill
devecocli init --agent agentname    # agentname需替换为实际的智能体名称
devecocli init --path D:\work\ARKTS\NewData -f

# 配置MCP
devecocli init --mcp
devecocli init --mcp --agent agentname    # agentname需替换为实际的智能体名称   
devecocli init --mcp --project D:\work\ARKTS\NewData -f

docs search

将关键词搜索版本说明、指南、API参考、最佳实践、FAQ 、变更预告等中的内容

命令格式：

devecocli docs search  --catalog  --format  --limit 

参数：

参数名	说明
keywords...	必选，搜索关键词，多个关键词用空格隔开
--catalog	可选，文档类别，取值包含harmonyos-releases（版本说明）、 harmonyos-guides（指南）、harmonyos-references（API参考）、best-practices（最佳实践）、harmonyos-faqs（FAQ）、harmonyos-roadmap（变更预告）、all（所有分类，默认）
--format	可选，控制输出格式，取值包括 default 、json ，默认为default ，输出结果包括文档ID、标题、文档的概括内容
--limit	可选，设置搜索结果返回条数，默认为10

示例：

devecocli docs search 沉浸光感
devecocli docs search '@State' '@Prop' --catalog best-practices --limit 10
devecocli docs search Row Column --format json

docs read

按文档ID查询文档的完整内容

命令格式：

devecocli docs read  

参数：

参数名	说明
documentId	必选，文档ID

示例：

devecocli docs read 开发指南/应用框架/UI_Design_Kit_UI设计套件/沉浸光感/ui-design-hds-component-material

docs catalog

查询文档分类和分类名称

命令格式：

devecocli docs catalog --format  

参数：

参数名	说明
--format	可选，输出格式，default 或 json ，默认为 default

示例：

devecocli docs catalog 
devecocli docs catalog --format json

create

创建 HarmonyOS 应用工程，仅支持创建工程模板中的 Empty Ability 模板

命令格式：

devecocli create --app-name  --project-path 
 --bundle-name  --api-level  

参数：

参数名	说明
--app-name	必选，应用名称
--project-path	可选，工程路径，默认为：./
--bundle-name	可选，包名，默认为：com.example. ，appname 自动转为小写
--api-level	可选，API级别，最小值为17，最大值从安装的 Deveco Studio 的 HarmonyOS SDK 中自动获取

示例：

devecocli create --project-path ./MyApp --app-name MyApp
devecocli create --project-path ./MyApp --app-name MyApp --bundle-name com.acme.myapp --api-level 23
devecocli create --app-name MyApp

auth login

登录华为开发者账号，打开浏览器完成授权。

命令格式：

devecocli auth login

说明：

• 海外账户暂不支持

auth logout

登出并清除本地存储的凭据

命令格式：

devecocli auth logout

auth status

显示当前登录的用户

命令格式：

devecocli auth status

auth team list

列出当前用户已加入的团队

命令格式：

devecocli auth team list

示例：

devecocli auth team list

build

编译并打包 HarmonyOS 工程或工程中的模块

命令格式：

devecocli build --product 
 --modules  --build-mode 

参数：

参数名	说明
--product	可选，产品的名称，默认为 default
--modules	可选，模块的名称。如需指定模块的 target 信息，使用 module@target 形式。当工程中只有一个模块时，可缺省；当工程中存在多个模块，且仅存在一个 entry 类型的模块时，可缺省
--build-mode	可选，构建模式，默认为 debug

示例：

devecocli build --build-mode release
devecocli build --modules entry library
devecocli build --modules library@phone
devecocli build --product oversea --modules entry --build-mode release

说明：

• 选定模块的依赖会被自动解析和构建
• 执行devecocli build --product 命令后，产物为 .app
• 执行devecocli build --product --modules 命令后，产物为 .hap / .hsp / .har

build clean

清理 HarmonyOS 项目的构建产物

命令格式：

devecocli build clean

check compat

基于 DevEco Studio 自带的 apkanalyzer-apiscan 插件，扫描源代码在两个 SDK 版本之间的 API 变更情况。

子命令：

子命令	说明
devecocli check compat	默认执行工程级扫描
devecocli check compat --modules [m2...]	按模块扫描
devecocli check compat [file2...]	按文件扫描（仅支持 .ets/.c/.cpp）
devecocli check compat versions	列出可用的目标 SDK 版本

命令格式：

devecocli check compat [files...] --source-version  --target-version  [--modules ] [--format ] [--output-path 
] [--limit ]

参数：

参数名	说明
--source-version	必填，当前工程 SDK 版本
--target-version	必填，目标 SDK 版本
--modules	可选，指定扫描的模块（多个以空格分隔）。与文件参数互斥
--format	可选，输出格式。default/csv/json。默认 default（控制台输出文本，文件输出 csv）
--output-path	可选，报告输出路径。目录或文件（扩展名必须与 --format 匹配）
--limit	可选，控制台显示的最大记录数，默认 100

版本号说明：

• 可用版本可通过 devecocli check compat versions 查看
• zsh 环境下版本号需用引号包裹（包含括号），例如 " "、""

compat versions 参数：

参数名	说明
--format	可选，输出格式。default 或 json。默认 default（文本输出，每行一个版本号）

格式与输出组合：

场景	允许的 --format	行为
控制台输出（无 --output-path）	default / json	default 输出文本表格，json 输出 JSON
文件输出（--output-path ，扩展名必须匹配 --format）	default / csv / json	default/csv 写 .csv 文件；json 写 .json 文件
目录输出（--output-path ，无扩展名）	default / csv / json	default/csv 生成 apiChange-res{N}.csv；json 生成 apiChange-res{N}.json

示例：

# 自动生成签名并写入工程配置
devecocli signature generate