DevEco CLI

一个面向 HarmonyOS 应用开发的统一命令行入口。

NPM Version NPM Downloads Node.js Platform DevEco Studio License

`DevEco CLI` 将 `DevEco Studio` 工具链统一封装为一个 `CLI`，内置 `ohpm`、`hvigor`、`hdc`、`emulator`、`hilog`，同时集成 HarmonyOS 技能安装、项目脚手架、本地 HarmonyOS 文档检索和 `MCP` 服务。 ## 快速开始 ### 前置要求 - 操作系统为 `macOS` 或 `Windows` - Node.js >= 18，推荐使用22及以上版本 - [DevEco Studio](https://developer.huawei.com/consumer/cn/download/) >= 6.1.0 - **macOS**：必须安装在 `~/Applications` 或 `/Applications` 目录下。 ### 安装 ```bash npm install -g @deveco/deveco-cli@latest ``` 安装后可以通过以下命令更新到最新版本： ```bash devecocli update ``` ### 最短工作流 ```bash devecocli create --app-name MyApp cd MyApp devecocli run devecocli log --level E ``` ### 文档检索 ```bash devecocli docs search List devecocli docs read harmonyos-guides/application-models/arkts-page-start-overview ``` 更多命令和参数可通过 `devecocli --help` 或各子命令的 `--help` 查看。 ## AI Agent 集成 `DevEco CLI` 支持通过命令行将自身技能添加到 `Agent` 中。下面以 `opencode` 为例展示最短流程： ```bash # 1. 给 opencode 安装 deveco-cli 技能 devecocli init --agent opencode # 2. 给 opencode 在当前 HarmonyOS 项目配置 MCP devecocli init --mcp --agent opencode --project ./MyApp # 3. 进入项目并启动 opencode cd MyApp opencode ``` 如果 `Agent` 不在 `--agent` 参数取值范围内，可使用 `--path` 参数进行添加，参考如下命令： ```bash devecocli init --path D:\work\ARKTS\NewData ``` 进入 `Agent` 后可以直接描述任务，例如： - `Build this project in release mode and run it on my emulator` - `Tail the last error logs from this app` - `Check for syntax errors in src/main/ets/pages/Index.ets` ## 常用命令 | 命令 | 用途 | | ------------------------- | ----------------------------------------- | | `devecocli create` | 创建新的 HarmonyOS 项目 | | `devecocli build` | 构建项目并产出 `.hap` / `.hsp` / `.har` / `.app` | | `devecocli check lint` | 检查代码规范并输出实践建议与报告 | | `devecocli run` | 安装并运行应用 | | `devecocli device list` | 查看当前连接设备 | | `devecocli emulator list` | 查看本地模拟器实例 | | `devecocli ui screenshot` | 对真机或模拟器执行 UI 截图 | | `devecocli log` | 查看 `hilog` 或崩溃日志 | | `devecocli docs search` | 搜索本地 HarmonyOS 文档 | | `devecocli init` | 安装内置技能或配置 `MCP` | | `devecocli skills` | 管理 HarmonyOS 技能市场中的技能 | | `devecocli check compat` | 扫描源代码在两个 `SDK` 版本之间的 `API` 变更 | ## 命令集 ### `help` 查看版本、帮助信息以及所有子命令 **命令格式：** ```bash devecocli help ``` ```text # 返回结果 Usage: devecocli [options] [command] HarmonyOS application development command line tool Options: -V, --version output the version number -h, --help display help for command Commands: build [options] Build the HarmonyOS project run [options] Build and run the project on a connected device update Update deveco-cli to the latest version device Manage connected devices emulator Manage emulator instances ui Inspect and interact with UI on a connected device skills Manage HarmonyOS skills log [options] Obtain device application logs create [options] Scaffold a new HarmonyOS application project init [options] Install the deveco-cli skill or configure the deveco-mcp server into AI agents serve Host bundled auxiliary protocol servers docs [options] Search and read HarmonyOS documentation from local docs directory check Run DevEco project checks help [command] display help for command ``` ### `init` 将`deveco-cli` `Skill` 或者 `MCP` 服务配置到智能体中 **命令格式：** ```bash devecocli init --agent --project --path --skill --mcp --force ``` **参数：** | 参数名 | 说明 | | ----------- | ----------------------------------------------------------------------------------------- | | --agent | 可选，智能体名称，多个智能体名称以英文逗号分隔。缺省时配置到所有已检测到的智能体中 | | --project | 可选，指定工程路径，将`deveco-cli` `Skill` 或 `MCP` 服务安装到该工程项目中 | | --path | 可选，指定 `deveco-cli` `Skill` 的配置路径。不可与 `--project` 、`--agent` 、 `--mcp` 同时使用 | | --skill | 可选，安装 `deveco-cli` `Skill`。不可与 `--mcp` 同时使用。`--mcp` 与 `--skill` 都缺省时，执行 `--skill` | | --mcp | 可选，配置 `MCP` 服务，与 `--project` 一起使用表示配置工程级 `MCP` 服务，独立使用表示配置用户级 `MCP` 服务。不可与 `--skill` 同时使用 | | -f, --force | 可选，当目标位置已存在 `deveco-cli` `Skill` 或 `MCP` 服务时，覆盖重装 | **示例：** ```bash # 配置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` 、变更预告等中的内容 **命令格式：** ```bash 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 | 可选，设置搜索结果返回条数，默认为20 | **示例：** ```bash devecocli docs search 沉浸光感 devecocli docs search '@State' '@Prop' --catalog best-practices --limit 10 devecocli docs search Row Column --format json ``` ### `docs read` 按文档ID查询文档的完整内容 **命令格式：** ```bash devecocli docs read ``` **参数：** | 参数名 | 说明 | | ---------- | ------- | | documentId | 必选，文档ID | **示例：** ```bash devecocli docs read 开发指南/应用框架/UI_Design_Kit_UI设计套件/沉浸光感/ui-design-hds-component-material ``` ### `docs catalog` 查询文档分类和分类名称 **命令格式：** ```bash devecocli docs catalog --format ``` **参数：** | 参数名 | 说明 | | -------- | ----------------------------------------- | | --format | 可选，输出格式，`default` 或 `json` ，默认为 `default` | **示例：** ```bash devecocli docs catalog devecocli docs catalog --format json ``` ### `create` 创建 HarmonyOS 应用工程，仅支持创建工程模板中的 `Empty Ability` 模板 **命令格式：** ```bash 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` 中自动获取 | **示例：** ```bash 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 ``` ### `build` 编译并打包 HarmonyOS 工程或工程中的模块 **命令格式：** ```bash devecocli build --product --modules --build-mode ``` **参数：** | 参数名 | 说明 | | ------------ | ------------------------------------------------------------------------------------------------------- | | --product | 可选，产品的名称，默认为 `default` | | --modules | 可选，模块的名称。如需指定模块的 `target` 信息，使用 `module@target` 形式。当工程中只有一个模块时，可缺省；当工程中存在多个模块，且仅存在一个 `entry` 类型的模块时，可缺省 | | --build-mode | 可选，构建模式，默认为 `debug` | **示例：** ```bash 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 项目的构建产物 **命令格式：** ```bash devecocli build clean ``` ### `check lint` 检查代码规范并输出实践建议与报告。 **命令格式：** ```bash devecocli check lint [path] ``` **参数：** | 参数名 | 说明 | | ---------------------------- | --------------------------------------------------------------------- | | `[path]` | 可选，待检查的文件或目录；默认使用 `build-profile.json5` 所在的项目根目录，否则使用当前目录 | | `--config-path ` | Code Linter 配置文件路径，仅支持 `.json` 或 `.json5`；默认使用待检查项目根目录下的 `code-linter.json5`，显式指定时必须与待检查路径属于同一项目 | | `--fix` | 自动修复可修复的问题 | | `--incremental` | 仅检查 Git 未提交文件 | | `--product ` | `build-profile.json5` 中定义的 product，默认为 `default` | | `--format ` | 完整报告格式；`default` 输出 Markdown，`json` 输出 JSON | | `--output-path ` | 完整报告文件或目录；目录形式会自动生成带时间戳的报告文件 | | `--limit ` | 未指定 `--output-path` 时，限制终端显示的问题数量 | ### `emulator list` 查看模拟器实例 **命令格式：** ```bash devecocli emulator list ``` ### `emulator start` 启动模拟器。首次使用时，需要签署 HarmonyOS 软件许可与服务协议，具体请参考 `emulator license` **命令格式：** ```bash devecocli emulator start [names...] ``` **参数：** | 参数名 | 说明 | | ----------- | ----------------------------------------- | | \[names...] | 必选，模拟器实例名称，多个名称用空格隔开。若名称中带有空格，则名称需要添加英文引号 | **示例：** ```bash devecocli emulator start Phone devecocli emulator start Phone1 Phone2 ``` **说明：** - `emulator start` 命令仅支持启动 `release` 版本的模拟器 ### `emulator stop` 关闭模拟器 **命令格式：** ```bash devecocli emulator stop [names...] ``` **参数：** | 参数名 | 说明 | | ----------- | ----------------------------------------- | | \[names...] | 必选，模拟器实例名称，多个名称用空格隔开。若名称中带有空格，则名称需要添加英文引号 | **示例：** ```bash devecocli emulator stop Phone devecocli emulator stop 127.0.0.1:5555 ``` ### `emulator` 场景操作 控制运行中的模拟器实例，直接映射 DevEco Studio 内置 Emulator 公开命令行参数。新增场景控制命令要求 Emulator 7.0 或更高版本；低版本会直接提示升级。截图不属于模拟器场景操作，统一通过 `devecocli ui screenshot` 执行。 **示例：** ```bash devecocli emulator shake --target Phone devecocli emulator power --target Phone devecocli emulator rotate left --target Phone devecocli emulator volume up --target Phone devecocli emulator fold half-open --target Phone devecocli emulator battery --target Phone --level 90 devecocli emulator battery --target Phone --status charging devecocli emulator geolocation --target Phone --longitude 116.400244 devecocli emulator scene outdoorRunning --target Phone devecocli emulator sensor --target Phone --heartrate 80 ``` **说明：** - `--target` 支持模拟器名称或 `127.0.0.1:` 序列号。 - `battery --level` 取值范围为整数 `[1, 100]`。 - `battery --status` 取值为 `charging` 或 `discharging`。 - `geolocation` 支持 `--longitude`、`--latitude`、`--altitude`、`--direction`。 - `scene` 取值为 `outdoorRunning`、`outdoorCycling`、`drivingNavigation`。 - `sensor` 支持 `--light-intensity`、`--humidity`、`--temperature`、`--steps`、`--heartrate`。 - `fold ` 会根据目标模拟器的设备类型校验状态，设备与参数必须匹配： | 设备类型 | 支持的 `state` | | --- | --- | | `foldable` | `open`、`half-open`、`close` | | `2in1_foldable` | `open`、`vertical-open`、`half-open`、`close` | | `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` | 校验以目标模拟器实际返回的 `deviceType` 为准。非上述三种设备类型以及不属于目标设备类型的状态会在命令下发前被拒绝。校验通过后，底层映射为 `Emulator -instance -foldedState `。 - 设置 `DEVECO_CLI_DEBUG=1` 可查看底层命令映射，例如 `Emulator -instance -shake`。 ### `ui screenshot` 对真机或模拟器执行 UI 截图。`devecocli ui` 当前只交付截图能力。 **命令格式：** ```bash devecocli ui screenshot [--device ] [--path ] ``` **参数：** | 参数 | 说明 | 默认值 | | ------------------------ | ------------------------ | ---------- | | --device \ | 真机或模拟器名称/序列号；多设备时必填 | 单设备自动选择 | | --display \ | 目标屏幕 ID，可选 | 默认屏幕 | | --path \ | 截图输出路径，可选；目录或父目录必须已存在 | `./screenshot-.png` | **示例：** ```bash devecocli ui screenshot --device Phone mkdir -p screenshots devecocli ui screenshot --device Phone --path ./screenshots/phone.png devecocli ui screenshot --device Phone --display 0 --path ./screenshots/phone.png ``` **说明：** - `ui screenshot` 支持真机和模拟器。 - 仅有一个可用设备时可省略 `--device`，多个设备同时连接时必须指定。 - 截图能力统一通过 `ui screenshot` 提供，不放在模拟器场景操作命令中。 - 截图统一使用 `hdc shell snapshot_display` 和 `hdc file recv` 实现；设置 `DEVECO_CLI_DEBUG=1` 可查看实际执行命令。 ### `emulator create` 创建模拟器 **命令格式：** ```bash devecocli emulator create --device-type --os-version --force ``` **参数：** | 参数名 | 说明 | | ------------- | ------------------------------------------------------------------------------------------------------------------------------- | | name | 必选，模拟器名称 | | --device-type | 必选，模拟器设备类型，支持 `phone` ， `foldable` ， `widefold` ， `triplefold` ， `tablet` ， `2in1` ， `2in1 foldable` ， `tv` ， `wearable` ，全小写 | | --os-version | 必选，模拟器镜像版本 | | --force | 可选，覆盖已有同名的模拟器 | **示例：** ```bash devecocli emulator create MyPhone --device-type phone --os-version "HarmonyOS 6.0.1(21)" ``` ### `emulator delete` 创建模拟器 **命令格式：** ```bash devecocli emulator delete ``` **参数：** | 参数名 | 说明 | | ---- | -------------- | | name | 必选，模拟器实例名称或序列号 | **示例：** ```bash devecocli emulator delete MyPhone ``` ### `emulator image list` 查询模拟器镜像列表 **命令格式：** ```bash devecocli emulator image list --device-type --all --format ``` **参数：** | 参数名 | 说明 | | ------------- | -------------------------------------------------------------------------------------------------------------------------- | | --device-type | 可选，模拟器设备类型，支持 `phone` ， `foldable` ， `widefold` ， `triplefold` ， `tablet` ， `2in1` ， `2in1 foldable` ， `tv` ， `wearable` | | --all | 可选，查询已下载和未下载的所有镜像 | | --format | 可选，控制输出格式，取值为 `table` 或 `json` ，默认为 `table` | **示例：** ```bash devecocli emulator image list devecocli emulator image list --all devecocli emulator image list --device-type phone devecocli emulator image list --format json ``` ### `emulator image download` 下载模拟器镜像。首次使用时，需要签署 HarmonyOS `SDK` 许可协议，具体请参考 `emulator license` **命令格式：** ```bash devecocli emulator image download --device-type --os-version --force ``` **参数：** | 参数名 | 说明 | | ------------- | ------------------------------------------------------------------------------------------------------------------------------- | | --device-type | 必选，模拟器设备类型，支持 `phone` ， `foldable` ， `widefold` ， `triplefold` ， `tablet` ， `2in1` ， `2in1 foldable` ， `tv` ， `wearable` ，全小写 | | --os-version | 必选，模拟器镜像版本 | | --force | 可选，覆盖已有的模拟器镜像 | **示例：** ```bash devecocli emulator image download --device-type phone --os-version "HarmonyOS 6.0.1(21)" --force ``` **说明：** - `emulator image download` 命令仅支持下载 `release` 版本的模拟器镜像 ### `emulator image remove` 删除模拟器镜像 **命令格式：** ```bash devecocli emulator image remove --device-type --os-version ``` **参数：** | 参数名 | 说明 | | ------------- | ------------------------------ | | --device-type | 必选，模拟器设备类型，与下载镜像的device-type一致 | | --os-version | 必选，模拟器镜像版本，与下载镜像的os-version一致 | **示例：** ```bash devecocli emulator image remove --device-type phone --os-version "HarmonyOS 6.0.1(21)" ``` ### `emulator license view` 查看协议文本（只读） **命令格式：** ```bash devecocli emulator license view ``` ### `emulator license` 交互式查看并接受协议。打印完整协议文本后提示 y/N 确认。使用模拟器需要同意 HarmonyOS 软件许可与服务协议，下载镜像需要同意 HarmonyOS `SDK` 许可协议。若已同意则直接提示已接受。非交互终端下会报错，请改用 `emulator license accept` **命令格式：** ```bash devecocli emulator license ``` ### `emulator license accept` 非交互式同意模拟器所有协议，直接写入同意记录，跳过协议展示和确认提示。适用于自动化脚本、CI 或非交互终端环境。若已同意则直接提示已接受 **命令格式：** ```bash devecocli emulator license accept ``` ### `device list` 查询所有已连接的设备，包括真机设备和运行中的模拟器 **命令格式：** ```bash devecocli device list ``` ### `device view` 查询已连接的设备的详细信息，包括设备序列号、设备名称、设备类型、 `OS` 版本等 **命令格式：** ```bash devecocli device view --target ``` **参数：** | 参数名 | 说明 | | ----------- | ------------------------------------- | | -t，--target | 可选，目标设备名称或序列号。多设备缺省时，会列出所有已连接设备序列号和名称 | **示例：** ```bash devecocli device view devecocli device view --target 127.0.0.1:5555 devecocli device view -t "My Device Name" ``` ### `run` 构建应用后，将应用安装到真机设备或模拟器上，并启动执行 **命令格式：** ```bash devecocli run --module --device --product --build-mode --ability --uninstall --skip-build --apply ``` **参数：** | 参数名 | 说明 | | ------------ |--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | --module | 可选，模块名称。如需指定模块的 `target` 信息，使用 `module@target` 形式。当工程中只有一个可运行模块（ `entry` / `feature` / `shared` ）时，可缺省 | | --device | 设备名称或设备序列号，单设备时可选，多设备时必选 | | --product | 可选，产品的名称，默认为 `default` | | --build-mode | 可选，构建模式名称，默认为 `debug` | | --ability | 可选，待启动的 `Ability` ，默认：模块 `module.json5` 中的`mainElement` | | --uninstall | 可选，安装前先卸载已有应用 | | --skip-build | 可选，跳过构建操作，直接安装应用 。\*\*说明：\*\*使用该参数时，需确保对应模块已有构建产物 | | --apply \ | 可选，**快速增量部署**：仅重编改动文件 → signed hqf → `bm quickfix -a -f -o` 安装 → 重启，比全量 `run` 快。`` 是工程 `.hvigor/` 目录下的**纯文件名**（调用方把清单写到此目录，文件名做安全校验防穿越）；内容为本轮改动的源文件路径清单（每行一个相对工程根路径；`#`/空行忽略；`.ets`/`.ts`/`.cpp`/资源文件；changeFileList 增量累积，只需列本轮改的，历史文件自动保留）。模块从清单路径自动识别（无需 `--module`）。**前提**：DevEco Studio ≥6.1.1（hvigor `assembleDevHqf` 支持，低于拒绝并提示升级）；先 `devecocli run` 全量构建部署一次（生成 buildConfig.json 缓存）；**没生效排查**：检查 `/build/config/buildConfig.json` 有无内容（空/无 = 没跑过 `devecocli run`）；**失败兜底**：直接 `devecocli run` | **示例：** ```bash devecocli run devecocli run --module entry --device 127.0.0.1:5555 devecocli run --module library@phone --device 127.0.0.1:5555 devecocli run --product oversea --module entry --ability EntryAbility devecocli run --build-mode release devecocli run --uninstall devecocli run --apply changes.txt ``` ### `log` 查看`hilog`普通日志或崩溃日志 **命令格式：** ```bash devecocli log --device --crash --level --bundle-name --keyword --tail --from --to --follow ``` **参数：** | 参数名 | 说明 | | ------------- | -------------------------------------------------------------------------------------------------------------------------- | | --device | 设备名称或设备序列号，单设备时可选，多设备时必选 | | --crash | 可选，查看崩溃日志 | | --level | 可选，日志级别，取值包括`D`（ `Debug` ）、`I`（ `Info` ）、`W`（ `Warn` ）、`E`（ `Error` ）、`F`（ `Fatal` ） | | --bundle-name | 可选，根据包名查看日志 | | --keyword | 可选，根据关键词查看日志，关键词区分大小写 | | --tail | 可选，显示最新的N行日志，取值为正整数 | | --from | 可选，起始时间，单位为`m`和`s`，`m`和`s`为小写，默认为`s`，`start`的取值需要大于等于`end` | | --to | 可选，结束时间，单位为`m`和`s`，`m`和`s`为小写，默认为`s` 。不可与--follow同时使用。**说明：** 如当前时间为05：00，`start`设置为30s，`end`设置为10s，则起始时间为04：30，结束时间为04：50 | | --follow | 可选，实时输出日志。不可与--to同时使用 | **示例：** ```bash devecocli log --level E devecocli log --crash --bundle-name com.example.app devecocli log --device 127.0.0.1:5555 --level W --keyword Init devecocli log --tail 100 --from 5m --to 2m devecocli log --follow --bundle-name com.example.app ``` ### `skills list` 查询可用的 `Skill` **命令格式：** ```bash devecocli skills list --long ``` **参数：** | 参数名 | 说明 | | --------- | ----------------------------------------------- | | -l，--long | 可选，`Skill` 详情，包括描述和已安装的智能体列表。缺省时，仅显示 `Skill` 名称 | **示例：** ```bash devecocli skills list devecocli skills list --long devecocli skills list -l ``` ### `skills find` 按关键词搜索 `Skill` **命令格式：** ```bash devecocli skills find ``` **参数：** | 参数名 | 说明 | | ------- | -------- | | keyword | 必选，搜索关键词 | **示例：** ```bash devecocli skills find deveco ``` ### `skills add` 将 `Skill` 添加到智能体中 **命令格式：** ```bash devecocli skills add --all --agent --skill --project --path --force ``` **参数：** | 参数名 | 说明 | | ---------- | --------------------------------------------------------- | | --all | 可选，添加所有可用的 `Skill` ，与 `--skill` 二选一 | | --agent | 可选，智能体名称，多个智能体时以英文逗号分隔。缺省时，添加到已检测到的智能体中 | | --skill | 可选，待添加的 `Skill` 名称，与 `--all` 二选一 | | --project | 可选，指定项目路径，将 `Skill` 添加到该工程项目中 | | --path | 可选，指定路径，将 `Skill` 添加到该路径，不可与 `--project` 或 `--agent` 同时使用 | | -f，--force | 可选，当目标位置已有同名 `Skill` 时，覆盖重添加 | **示例：** ```bash devecocli skills add --all devecocli skills add --skill skillname --agent agentname --force # skillname需替换成实际的Skill名称 devecocli skills add --skill skillname --project ./my-app # skillname需替换成实际的Skill名称 ``` ### `skills remove` 从智能体中删除已添加的 `Skill` **命令格式：** ```bash devecocli skills remove --skill --agent --project --path ``` **参数：** | 参数名 | 说明 | | --------- | -------------------------------------------------------- | | --skill | 必选，待删除的 `Skill` 名称 | | --agent | 可选，智能体名称，多个智能体时以英文逗号分隔。缺省时，删除到已检测到的智能体中的 `Skill` | | --project | 可选，指定项目路径，删除该项目中的 `Skill` | | --path | 可选，指定路径，删除该项目中的 `Skill`，不可与 `--project` 或 `--agent` 同时使用 | **示例：** ```bash devecocli skills remove --skill skillname # skillname需替换成实际的Skill名称 devecocli skills remove --skill skillname --agent agentname # skillname需替换成实际的Skill名称 ``` ### `serve mcp` 启动本地 `MCP` 服务。智能体配置 `MCP` 服务后，可通过 `MCP` 协议调用 `ArkTS` / `C++` 语法检查工具。不同智能体平台配置 `MCP` 服务的界面不一样，一个智能体平台的配置示例如下。 推荐通过 `devecocli init --mcp` 自动配置 ```bash { "mcp": { "deveco-mcp": { "type": "local", "command": [ "devecocli", "serve", "mcp" ], "environment":{ "PROJECT_PATH": "D:\\code\\sample_project", // 工程路径 "NODE_MAX_OLD_SPACE_SIZE": "8192", // 可选，设置内部node进程最大的老生代内存大小，默认为8192 "DEVECO_PATH": "D:\\Application\\DevEco Studio" // 可选，Deveco Studio的路径 }, "enbale": true } } } ``` ### `serve lsp` 启动本地 `LSP` 语言服务。智能体配置 `LSP` 服务后，可通过 `LSP` 协议获取代码补全、跳转定义、悬浮提示、引用查找、诊断等语言特性。当前支持 `ArkTS`和 `clangd`。 ```bash { "lsp": { "ArkTS": { "command": [ "devecocli", "serve", "lsp", "--arkts" ], "extensions": [ ".ets" ] }, "clangd": { "command": [ "devecocli", "serve", "lsp", "--cpp" ], "extensions": [ ".c", ".cpp", ".cc", ".cxx", ".h", ".hpp", ".hxx", ".hh" ] } } } ``` **参数：** | 参数名 | 说明 | | --- | --- | | `--arkts` | 与 `--cpp` 二选一，启动 ArkTS 语言服务（ace-server） | | `--cpp` | 与 `--arkts` 二选一，启动 C/C++ 语言服务（clangd） | | `--project-path ` | 可选，工程根路径，默认为当前工作目录 | | `--auto-detect` | 可选，当前目录向下查找工程根（检查当前目录自身及其子目录，最多 3 层子目录）；适用于 `--arkts` 和 `--cpp`；指定了 `--project-path` 则忽略 | ### `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` 版本 | **命令格式：** ```bash 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` 环境下版本号需用引号包裹（包含括号），例如 `""`、`""` **格式与输出组合：** | 场景 | 允许的 `--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` | **示例：** ```bash # 工程级扫描，输出到控制台 devecocli check compat --source-version "" --target-version "" # 输出 JSON 到控制台 devecocli check compat --format json --source-version "" --target-version "" # 输出报告到目录（默认 csv） devecocli check compat --output-path ./report --source-version "" --target-version "" # 输出 JSON 报告到目录（生成 apiChange-res{N}.json） devecocli check compat --output-path ./report --format json --source-version "" --target-version "" # 输出报告到指定文件 devecocli check compat --output-path ./report.json --format json --source-version "" --target-version "" # 文件级扫描 devecocli check compat ./entry/src/main/ets/pages/Index.ets --source-version "" --target-version "" # 模块级扫描 devecocli check compat --modules entry har1 --source-version "" --target-version "" ``` ## 常见问题 [FAQ](https://gitcode.com/openharmony-sig/deveco-cli/wiki/FAQ.md) ## 开发 ```bash npm install npm run dev npm start -- npm run lint npm run format npm run build ``` - 架构与目录说明见 [`AGENTS.md`](./AGENTS.md) - 如需参与维护，建议先阅读 `AGENTS.md` 中的约定与架构说明 ## 许可证 [MIT](./LICENSE)