DevEco CLI命令速查表:从create、build到signature的HarmonyOS命令行工具全景
【免费下载链接】deveco-cli集成HarmonyOS应用开发工具集,提供知识文档和精品Skills,支持多种智能体,助力开发者使用AI辅助高效开发HarmonyOS应用。项目地址: https://gitcode.com/openharmony-sig/deveco-cli
本文带你快速掌握 HarmonyOS 命令行工具的完整命令体系。DevEco CLI(命令devecocli)是一套集成 HarmonyOS 应用开发的统一命令行工具集,一条命令覆盖"创建工程 → 构建 → 运行 → 查日志 → UI 自动化 → 应用签名"全流程,还内置本地文档检索与 AI 智能体技能。
什么是 DevEco CLI?🔌
DevEco CLI 将 DevEco Studio 工具链统一封装为命令行入口,内置ohpm、hvigor、hdc、emulator、hilog能力,并集成 HarmonyOS 技能安装、项目脚手架、本地文档检索和 MCP 服务。支持 macOS、Windows、Linux。
| 环境要求 | 最低版本 |
|---|---|
| Node.js | ≥ 22 |
| DevEco Studio | ≥ 6.0.0 |
| Command Line Tools | ≥ 26.0.0(Linux 必选) |
一行命令全局安装:
npm install -g @deveco/deveco-cli@latest命令全景:15 个顶层命令速查表 📋
下面是 DevEco CLI 命令速查表的核心,覆盖全部顶层命令(源码入口见 packages/cli/src/cli.ts):
| 命令 | 用途 | 最小示例 |
|---|---|---|
create | 脚手架新建 HarmonyOS 工程 | devecocli create --app-name MyApp |
build | 构建产出.hap/.hsp/.har/.app | devecocli build --build-mode release |
run | 安装并运行应用(附冒烟检查) | devecocli run --device 127.0.0.1:5555 |
log | 查看 hilog 普通日志或崩溃日志 | devecocli log --level E |
device | 查看设备、传文件、执行 sqlite3 | devecocli device list |
emulator | 模拟器管理与场景模拟 | devecocli emulator start Phone |
ui | 截图、录屏、点击、滑动、布局导出 | devecocli ui screenshot --path ./shots |
check | lint / ArkTS 静态检查 / API 兼容扫描 | devecocli check lint |
docs | 搜索、阅读本地 HarmonyOS 文档 | devecocli docs search 沉浸光感 |
skills | 管理 HarmonyOS 技能市场技能 | devecocli skills add --all |
init | 给 AI 智能体配置 Skill 或 MCP | devecocli init --mcp --agent opencode |
serve | 启动本地 MCP / LSP 服务 | devecocli serve mcp |
signature | 自动生成调试签名材料 | devecocli signature generate |
auth | 华为开发者账号登录与团队管理 | devecocli auth login |
update | 升级 CLI 到最新版本 | devecocli update |
最短工作流:从 create 到 run 🚀
日常开发只需记住这四步(完整参数详见 README.md):
devecocli create --app-name MyApp cd MyApp devecocli run devecocli log --level E1️⃣ create —— 一行命令创建 HarmonyOS 工程
create基于内置Empty Ability模板生成工程骨架(模板源码见 packages/cli/templates/):
devecocli create --app-name MyApp| 常用参数 | 说明 |
|---|---|
--app-name | 必选,应用名称 |
--project-path | 工程路径,默认./<app-name> |
--bundle-name | 包名,默认com.example.<app-name> |
--api-level | API 级别,最小 17,上限取自已安装 SDK |
2️⃣ build —— 构建打包出产物
devecocli build --build-mode release devecocli build --modules entry library devecocli build clean # 清理构建产物只构建工程时产出.app;指定--modules时按模块产出.hap/.hsp/.har,模块依赖会自动解析构建。
3️⃣ run —— 一键安装运行,自带冒烟检查
run完成"构建 → 安装 → 启动",并在启动后自动执行冒烟检查(进程存活 + 截图空白屏检测),失败会输出崩溃日志或截图路径,命令以非零码退出,方便接入 CI。
devecocli run devecocli run --uninstall # 先卸载再安装 devecocli run --hotreload # 开启热重载,stop 子命令停止4️⃣ log —— hilog 日志与崩溃日志排查
devecocli log --level E devecocli log --crash --bundle-name com.example.app devecocli log --follow --tail 100--level支持D/I/W/E/F五个级别,--keyword、--from/--to可按关键词和时间窗过滤,实现类tail -f的实时日志跟踪。
device 与 emulator:真机和模拟器管理 📱
device —— 设备侧操作
| 子命令 | 作用 |
|---|---|
device list | 查看所有已连接设备(真机 + 运行中的模拟器) |
device view | 查看设备序列号、名称、类型、OS 版本 |
device file send/recv | 主机与设备间传文件 |
device sqlite3 | 直接在设备上执行 sqlite3 查询 |
emulator —— 模拟器的完整生命周期
- 实例管理:
emulator list/start/stop/create/delete - 镜像管理:
emulator image list/image download/image remove - 许可协议:
emulator license accept(自动化脚本推荐,非交互直接同意)
更强大的是场景模拟,可远程控制运行中的模拟器:震动、开关机、旋转屏幕、音量、折叠状态、电量、GPS 定位、运动场景(跑步/骑行/驾车导航)、传感器(心率/温度/湿度)等:
devecocli emulator battery --target Phone --level 20 devecocli emulator geolocation --target Phone --longitude 116.4 --latitude 39.9ui:UI 检查与自动化操作全家桶 🖱️
ui子命令面向真机与模拟器,是 UI 调试与自动化测试的核心:
| 子命令 | 作用 |
|---|---|
ui screenshot | 对真机或模拟器截图 |
ui screenrecord | 录制真机屏幕为 MP4 |
ui click/doubleclick/longclick | 点击、双击、长按(支持坐标或节点 ID) |
ui swipe/fling/drag/dircfling | 滑动、快速滑动、拖拽、按方向滑动 |
ui text | 向焦点或指定节点输入文本 |
ui layout | 导出 UI 节点树(类型、ID、坐标、文本、可交互标志) |
ui window list | 查看窗口列表,为 layout/click 提供窗口 ID |
典型调试链路:ui window list拿窗口 ID →ui layout拿节点 ID 和坐标 →ui click --id xxx精准点击,无需手算坐标。
docs 与 skills:本地文档检索与 AI 技能集成 🤖
docs —— 离线 HarmonyOS 文档检索
无需联网即可搜索版本说明、指南、API 参考、最佳实践、FAQ 等分类:
devecocli docs catalog # 查看文档分类 devecocli docs search '@State' --catalog best-practices devecocli docs read <documentId> # 按 ID 读完整文档 devecocli update docs # 更新到最新兼容版本skills + init + serve —— 让 AI 智能体帮你写 HarmonyOS 应用
| 命令 | 作用 |
|---|---|
skills list/find | 查询与搜索可用 HarmonyOS 技能 |
skills add/remove | 将技能安装到或移出智能体 |
init --agent <名称> | 给指定 AI 智能体安装 CLI 技能 |
init --mcp --project <路径> | 为工程配置 MCP 服务 |
serve mcp | 启动本地 MCP 服务 |
serve lsp --arkts/--cpp | 启动 ArkTS / C++ 语言服务 |
配置 MCP 后,智能体可通过check、hover、definition、references、callHierarchy等工具直接调用代码分析与语言特性,例如让 Agent"检查这个 .ets 文件的语法错误"或"构建 release 包并运行到模拟器"。
check 与 signature:代码质量和应用签名 🔐
check —— 三种质量检查
| 子命令 | 作用 |
|---|---|
check lint | 代码规范检查,支持--fix自动修复、增量检查 |
check arkts | 对.ets文件执行 ArkTS 静态检查 |
check compat | 扫描两个 SDK 版本间的 API 变更,支持文件/模块/工程级 |
signature —— 一键生成调试签名
signature generate自动生成 p12 密钥库、csr 请求文件、p7b 配置和 cer 证书,并把签名配置写入项目的build-profile.json5,省去手动申请证书的步骤:
devecocli signature generate devecocli signature generate --force # 覆盖已有证书auth 与 update:账号登录和版本升级 ⬆️
devecocli auth login # 浏览器授权登录华为开发者账号 devecocli auth status # 查看当前登录用户 devecocli auth team list # 列出已加入团队 devecocli update # 升级到最新版实用技巧清单 💡
- 随时查帮助:
devecocli --help或任意子命令加--help,无需记忆全部参数。 - 机器可读输出:多数查询命令支持
--format json,方便脚本处理。 - 多设备场景:连接多台设备时,
--device(名称或序列号)为必填。 - 非默认安装路径:设置
DEVECO_CLI_STUDIO_PATH或DEVECO_CLI_CLT_PATH显式指定工具链,优先级Studio > CLT > 自动检测。 - 排查底层命令:设置
DEVECO_CLI_DEBUG=1可查看实际执行的 hdc/Emulator 命令。
总结
DevEco CLI 把 HarmonyOS 命令行工具整合为一条devecocli:create起步、build构建、run运行、log排查、emulator/ui调试、signature收尾,再加上docs本地文档与skills/init的 AI 集成,构成覆盖开发全流程的 HarmonyOS 命令行工具全景。建议收藏本文的速查表,配合--help按需深入,让 HarmonyOS 开发更顺手。
【免费下载链接】deveco-cli集成HarmonyOS应用开发工具集,提供知识文档和精品Skills,支持多种智能体,助力开发者使用AI辅助高效开发HarmonyOS应用。项目地址: https://gitcode.com/openharmony-sig/deveco-cli
创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考