[鸿蒙PC命令行移植适配]移植rust三方库peep到鸿蒙PC的完整实践
欢迎加入【开源鸿蒙PC社区】，一起共建鸿蒙化C/C++三方库生态。
前言
peep是由 ryochack 开发的终端文本查看工具，采用 Rust 语言编写。它像less命令一样运行，但在终端窗口内以一个独立的小面板（pane）展示文件内容，支持文件的自动更新监视（follow mode），让你在不离开当前工作上下文的前提下快速预览文件内容，是查看日志、代码片段和配置文件的理想工具。
前置条件
| 环境/工具 | 描述 |
|---|---|
| 适配库 | peep |
| 开源协议 | "MIT" |
| 源码版本 | 0.1.6 |
| 目标平台 | 鸿蒙PC |
| 依赖项 | 无 |
| 操作系统平台 | macOS |
| 原仓库地址 | https://github.com/ryochack/peep |
| 鸿蒙化适配仓库地址 | https://atomgit.com/OpenHarmonyPCDeveloper/ohos-peep |
在Ubuntu中搭建鸿蒙PC 三方库交叉编译构建开发环境 | https://blog.csdn.net/zl392321162/article/details/159284760 |
在macOS中搭建鸿蒙 PC 三方库交叉编译开发环境 | https://blog.csdn.net/zl392321162/article/details/159284830 |
Windows 10上安装和使用WSL 2、安装Ubuntu 24详细指南 | https://blog.csdn.net/yyz_1987/article/details/148545443 |
| 鸿蒙 PC 命令行适配指南（Mac 版） | https://blog.csdn.net/qq_39132095/article/details/154796658 |
| 鸿蒙 PC 生态三方软件移植：开发环境搭建及三方库移植指南 | https://blog.csdn.net/yyz_1987/article/details/154794871 |
OpenHarmony Linux 命令行工具适配实战：基于Cursor × WSL的tree 2.2.1交叉编译与HNP打包全流程指南 | https://weishuo.blog.csdn.net/article/details/155140843 |
社区维护的鸿蒙 PC 生态命令行工具构建框架lycium_plusplus | https://atomgit.com/OpenHarmonyPCDeveloper/lycium_plusplus |
| 支持Rust三方库适配的扩展lycium框架 | https://atomgit.com/CodexBai/lycium_plusplus.git |
| 鸿蒙PC端二进制文件签名命令行使用指南 | https://blog.csdn.net/jianguo888888/article/details/156644386 |
hnp包验证环境 | https://bxming.blog.csdn.net/article/details/155073889 |
系列索引
| 篇章 | 标题 | 内容 |
|---|---|---|
| 第一篇 | 概述与环境配置 | Lycium 概念、构建机要求、OHOS SDK 配置 |
| 第二篇 | 项目结构与适配目录创建 | 目录结构、community vs thirdparty、创建适配目录 |
| 第三篇 | HPKBUILD 编写详解 | 元数据字段、过程函数、三种构建系统写法 |
| 第四篇 | 构建执行与产物获取 | 构建流程、日志分析、多库递归、HAP 集成 |
| 第五篇 | 流程图与角色职责 | 完整流程图、各角色职责、协作时序 |
| 第六篇 | 关键注意事项与最佳实践 | 依赖管理、架构超集、日志调试、外部适配仓 |
| 第七篇 | 快速参考与模板 | 入门步骤、模板、完整案例、检查清单 |
| 第八篇「番外」 | 扩展lycium框架使其满足rust三方库适配 | 不改变框架原有设计，增加Rust三方库适配能力 |
一、环境配置
1 OpenHarmony SDK 安装
1.1 下载 SDK（环境搭建）
- 在浏览器中打开 DCP 每日构建列表：https://dcp.openharmony.cn/workbench/cicd/dailybuild/dailylist
- 在列表中按本机操作系统选择对应产物（名称随版本变化，以页面为准）：
| 开发机系统 | 选择产物（关键词） |
|---|---|
| Windows / Linux | ohos-sdk-full（OHOS 全量 SDK，用于交叉编译） |
| macOS | mac-sdk-full（Mac 版 SDK 包） |
下载到本机后解压（请将下面文件名替换为你实际下载的包名）：
cd~# Linux / macOS 示例（包名以 DCP 页面为准）tar-zvxf<你下载的-sdk-xxx>.tar.gzWindows 请使用资源管理器或 7-Zip 等工具解压对应.zip/.tar.gz包。
说明：每日构建会更新版本与文件名，不要固定使用旧文档中的直链；以 DCP 页面上当前可下载的 SDK 包为准。解压后若顶层目录名不是
ohos-sdk，可将该目录移动或软链为~/ohos-sdk（或 Windows 下放到固定路径），与下文OHOS-SDK配置一致。
再进入ohos-sdk根目录解压（文件名以darwin目录下为准，下例版本号仅作演示）：
cd~/ohos-sdk# Linux / macOS；Windows 请先 cd 到 OHOS_SDK 目录unzipnative-darwin-arm64-6.0.0.46-Beta1.zipunziptoolchains-darwin-arm64-6.0.0.46-Beta1.zipWindows 可对两个 zip右键解压到当前文件夹，或使用tar/Expand-Archive等工具解压到ohos-sdk根目录。
解压完成后，应得到native/、toolchains/等目录（含llvm、sysroot、hnpcli等），再配置2.1.3中的环境变量。
1.2 SDK 目录结构
ohos-sdk/ ├── native/ │ ├── llvm/bin/ # 编译器工具链 │ ├── sysroot/ # 系统根目录（头文件和库） │ └── build-tools/ # 构建工具 └── toolchains/ └── hnpcli # HNP打包工具1.3 环境变量配置
编辑~/.zshrc（如果使用 zsh）或~/.bash_profile（如果使用 bash）：
# OpenHarmony SDK 路径exportOHOS_SDK=~/ohos-sdk# 添加到 PATHexportPATH="$OHOS_SDK/native/llvm/bin:$PATH"exportPATH="$OHOS_SDK/native/build-tools/cmake/bin:$PATH"exportPATH="$OHOS_SDK/toolchains/bin:$PATH"# 验证source~/.zshrc# 或 source ~/.bash_profile1.4 验证 SDK 配置
# 检查 SDK 路径echo$OHOS_SDK# 检查工具是否在 PATH 中whichclangwhichcmakewhichhnpcli# 检查 SDK 工具目录ls$OHOS_SDK/native/llvm/bin/ls$OHOS_SDK/native/build-tools/cmake/bin/ls$OHOS_SDK/toolchains/# 验证工具版本clang--versioncmake--versionhnpcli--version2 Rust 工具链安装
2.1 安装 Rust
# 安装 Rust（如果未安装）curl--proto'=https'--tlsv1.2-sSfhttps://sh.rustup.rs|shsource~/.cargo/env# 验证安装rustc--versioncargo--version2.2 配置 Rust 环境变量
编辑~/.zshrc（如果使用 zsh）或~/.bash_profile（如果使用 bash）：
# Rust 环境变量（通常由 rustup 自动添加）source~/.cargo/env# 验证source~/.zshrc# 或 source ~/.bash_profilerustc--versioncargo--version二、适配步骤
1. 分析peep构建特性
peep由Rust语言编写，使用Cargo作为构建系统。编译后产出的二进制命令为peep（在Cargo.toml的[package]中name = "peep"定义）。
核心特性
Less 风格的面板查看
peep类似于less命令，但在终端中以独立小面板（pane）形式呈现文件内容，支持上下滚动、搜索跳转等常见分页操作，且退出后面板内容仍保留在终端缓冲区中，方便回顾。文件自动监视（Follow Mode）
支持
-f/--follow选项，当文件被追加写入时自动滚动显示最新内容，效果类似tail -f，非常适合实时跟踪日志文件变化。支持inotify机制，监视文件变更事件。纯键盘交互操作
提供
j/k上下滚动、g/G跳转首尾行、/正向搜索、n/N跳转上/下一个匹配项、q/Q退出等直观的键盘快捷键，操作习惯与less/vim一致，学习成本极低。内容搜索与高亮
内置正则表达式搜索功能，在文件中向前搜索匹配内容并高亮显示，支持
n/N键快速跳转上/下一个匹配结果，帮助快速定位关键文本。自定义起始行
通过
--start参数指定起始显示行号，在查看大型日志或代码文件时可以从指定位置开始浏览，避免从头翻页。轻量无外部依赖
编译后为单一二进制文件，无运行时外部依赖，二进制体积小（约 600KB），启动速度快，适合在资源受限的鸿蒙设备中作为默认文本预览工具使用。
2. 创建适配项目
参考前置条件列表完成lycium_plusplus交叉框架编译环境搭建，以及lycium_plusplus交叉框架代码克隆，在lycium_plusplus/RustAdapt创建目标库peep适配目录为ohos-peep。
为什么是
ohos-peep？为了和源库名称做区分，表示该库用于ohos设备。
ohos-peep创建可以借助编辑器工具（如VSCode）或者使用文件夹在lycium_plusplus/RustAdapt目录下创建目标库适配目录ohos-peep，也可以执行以下命令进行创建。
# 我将交叉编译框架克隆在根目录，此处可改为正确的目录地址cd~/lycium_plusplus/RustAdaptmkdirohos-peep3. 编写HPKBUILD
然后将lycium/template/HPKBUILD.cargo拷贝到RustAdapt/ohos-peep目录下，并重命名为HPKBUILD，HPKBUILD是lycium交叉编译框架完成编译构建的核心配置文件，定义包的元信息、依赖、构建和打包逻辑。需要根据模板在HPKBUILD开头声明peep的基本信息，这些字段被lycium用于下载、组织和记录：
# lycium_plusplus/RustAdapt/ohos-peep/HPKBUILDpkgname=peep# 库名pkgver=0.1.6# 库版本pkgrel=0# 发布号pkgdesc="The CLI text viewer tool that works like 'less' command on small pane within the terminal window."# 库描述url="https://github.com/ryochack/peep"# 官网链接archs=("arm64-v8a")# cpu 架构license=("MIT")depends=()# 依赖库的目录名 必须保证被依赖的库的archs是当前库的archs的超集makedepends=("cargo""rustc")# 构建库时的依赖工具->需要用户安装的工具source="https://github.com/ryochack/peep/archive/refs/tags/v${pkgver}.tar.gz"# 库源码下载链接downloadpackage=true# 是否自动下载压缩包，如若不写默认 true. (应对一些特殊情况，代码只能 git clone (项目中依赖 submoudle ))autounpack=true# 是否自动解压，如若不写默认 true, 如果为 false 则需要用户在 prepare 函数中自行解压buildtools=cargo# 编译方法: cmake(默认) | configure | cargo | 其它则不在此注入 buildargs，由 build() 自行处理builddir=peep-${pkgver}# 源码压缩包解压后目录名 编译目录名packagename=$builddir.tar.gz# 压缩包名| 字段 | 配置值 | 用途 |
|---|---|---|
pkgname | peep | pkgname=peep：包名，用于在LYCIUM_ROOT/usr/下创建安装目录、标识依赖关系。 |
pkgver | 0.1.6 | pkgver=0.1.6：上游版本号，与https://github.com/ryochack/peep仓库最新发行版本保持一致。 |
pkgrel | 0 | pkgrel=0：包发布号，当同一上游版本需要重新打包时递增，首次适配为 0。 |
pkgdesc | - | 包的简短描述，取自peep官方Cargo.toml。 |
url | - | 上游项目主页URL。 |
archs | ("arm64-v8a") | archs=("arm64-v8a")：声明支持的架构数组。此处仅列出arm64-v8a，但代码内部实际也处理了armeabi-v7a和x86_64，此处是声明"主要支持"而非"仅支持"。当前鸿蒙 PC 设备为arm64架构，因此必须配置arm64-v8a。 |
license | ("MIT") | peep采用MIT协议。 |
depends | () | 无运行时依赖。 |
makedepends | ("cargo" "rustc") | makedepends=("cargo" "rustc")：编译时依赖。Rust工具链是构建前提。 |
source | refs/tags/v${pkgver}.tar.gz | 源码包下载地址。使用${pkgver}变量拼接，下载peep 0.1.6的release tarball（注意标签含v前缀）。 |
downloadpackage | true | downloadpackage=true：告诉lycium构建系统自动下载source指定的源码包。如果设置为false需要在目标库目录下手动下载源码包。 |
autounpack | true | autounpack=true：下载后自动解压，无需手动解压步骤。如果设置为false需要手动解压。 |
buildtools | cargo | buildtools=cargo：声明构建工具类型。lycium据此选择Cargo构建流程（而非make/cmake等）。 |
builddir | peep-${pkgver} | builddir=peep-${pkgver}：解压后的源码目录名。prepare()/build()/package()均通过cd $builddir进入此目录。 |
packagename | ${builddir}.tar.gz | packagename=${builddir}.tar.gz：源码包文件名，用于校验/定位。 |
还需要修改package函数中编译完成后的二进制文件名称，peep项目编译完成后，会产出一个名为peep的二进制文件（在Cargo.toml的[package]中name = "peep"定义），此处需要将cp target/${OHOS_RUST_TARGET}/release/xxx改为cp target/${OHOS_RUST_TARGET}/release/peep并复制到安装目录。
# 打包安装package(){# 进入 Rust 项目目录（和编译时同一个目录）cd$builddir# 定义安装路径：鸿蒙库的安装目录DEST="$LYCIUM_ROOT/usr/$pkgname/$ARCH"# 创建安装目录bin 文件夹mkdir-p$DEST/bin/# 【关键】把编译好的 Rust 程序 → 复制到目标目录的 bin 文件夹cptarget/${OHOS_RUST_TARGET}/release/peep"$DEST/bin/"cd$OLDPWD}4 HNP 打包配置
在lycium_plusplus/RustAdapt/ohos-peep目录下创建hnp.json文件，因为在HPKBUILD中存在archive函数，用于将产物打包为output/<arch>/<pkgname>_<ver>.tar.gz，或执行 HNP 打包，详细介绍可参考系列索引-构建执行与产物获取。
{"type":"hnp-config","name":"peep","version":"0.1.6","install":{}}5 交叉编译并解决可能存在的问题
HPKBUILD中函数不做改变，在lycium_plusplus/lycium目录下打开终端工具，输入./build.sh ohos-peep进行第一次交叉编译。
交叉编译未通过，错误详情为：
error: could not compile`nix`(lib)due to51previous errors出现该问题的原因是libc 0.2.126不支持 OHOS，nix 0.24不兼容新 libc，ctrlc 3.2拉入nix 0.24，mio缺少os-poll/os-ext，tokio传递依赖socket2 0.4缺少IovLen支持。针对libc和socket可以直接在HPKBUILD中的build方法cargo build ...之前通过cargo update自动升级，对于nix、crtlc、mio需要在perpare方法通过sed方式升级，确保旧版本不会被强制依赖。
prepare(){cd$builddirmkdir-p.cargo# patch: 升级关键依赖到支持 OHOS 的版本sed-i'''s/nix = "0.24"/nix = "0.31"/'Cargo.tomlsed-i'''s/ctrlc = "3.2"/ctrlc = "3.5"/'Cargo.toml# mio 需要启用 os-poll + os-ext + net 特性（peep 使用 mio::unix::SourceFd 和 Poll::new）sed-i'''s/mio = "0.8"/mio = { version = "0.8", features = ["os-poll", "os-ext", "net"] }/'Cargo.tomlcd${OLDPWD}}# ${OHOS_SDK} oh sdk安装路径# $ARCH 编译的架构是 archs 的遍历# $LYCIUM_ROOT/usr/$pkgname/$ARCH 安装到顶层目录的usr/$pkgname/$ARCH# 执行编译构建的命令build(){# 进入编译工作目录（Rust 项目源码所在文件夹）cd$builddir# 【关键】更新所有依赖到最新兼容版本（支持 OHOS 目标）cargoupdate# 【核心编译命令】正式编译 Rust 项目# --release ：编译正式发布版（优化、速度快）# --target ：指定编译目标架构（鸿蒙：aarch64-unknown-linux-ohos）# ${OHOS_RUST_TARGET:?} ：必须有这个环境变量，否则直接报错退出cargobuild--release--target"${OHOS_RUST_TARGET:?}"# 对最关键一步的退出码进行判断ret=$?cd$OLDPWDreturn$ret}如果提示ALL JOBS DONE!!!表示当前交叉编译没有问题，编译后的产物，可以在lycium/usr/目录和out/arm64-v8目录下查看。
三、 在鸿蒙PC上验证交叉编译后的peep命令是否可用
将lycium_plusplus/lycium/usr/peep/arm64-v8a/bin/peep二进制文件传到鸿蒙PC上，方式有多种，可以通过聊天软件。macos设备可以在App Store下载【鸿蒙星河互联】，通过分享方式将peep二进制文件发送到鸿蒙PC设备上，这种方式需要鸿蒙PC开启华为分享为所有人可见。在鸿蒙PC右下角会弹出接受弹窗，选择"接受"或者"另存为"，接受peep二进制文件。接受后的二进制文件是不可以直接运行的，哪怕使用chmod +x peep这种方式授权也是无法运行的。需要给二进制文件进行签名后才可以，在鸿蒙 PC 侧执行前涉及二进制签名流程，可参考《鸿蒙PC端二进制文件签名命令行使用指南》。打开鸿蒙PC终端，输入以下命令为peep签名授权。
# 进入peep所在目录cdDesktop# 执行签名binary-sign-tool sign-inFilepeep-outFilepeep-selfSign"1"# 授予权限chmod+x peep# 查看peep版本./peep--version四、 FAQ
执行签名命令出现“zsh: command not found: binary-sign-tool”提示。
需要在应用市场搜索DevBox并安装，DevBox提供了一些开发者常用命令，主要包含文件和目录操作命令、网络命令、构建命令、签名工具等。