命令行
HaloForge 带有一个本地命令行工具:hf。它和桌面应用使用同一份本地 workspace 数据,所以很适合做插件测试、自动化和发布后的 catalog 操作。
源码开发时,从 HaloForge 桌面仓库运行:
cd /path/to/HaloForgenpm run hf -- --help安装版的可用性和平台有关:
| 平台 | 当前状态 |
|---|---|
| Windows | NSIS/MSI 安装包会把 HaloForge 安装目录加入 PATH。安装或更新后重新打开终端,再运行 hf --help。 |
| macOS | 当前还没有自动创建 PATH link。先运行 command -v hf 检查;如果没有输出,请使用上面的源码命令,或手动指向你自己构建出的 hf binary。 |
文档里的 npm run hf -- ... 在 hf 已经进入 PATH 的环境里可以简化为 hf ...。
安装本地插件包并确认状态:
npm run hf -- plugin install local /path/to/plugin/dist/package/<plugin-id>-<version>.hfpkg --jsonnpm run hf -- plugin list --json从公开 catalog 安装官方插件:
npm run hf -- plugin install official markdown --jsonnpm run hf -- plugin install official git p4 aireplay --json插件测试时查看日志
Section titled “插件测试时查看日志”hf 负责安装和检查本地插件包;运行时日志仍由 HaloForge 应用统一写入:
tail -f ~/.haloforge/logs/haloforge.log.$(date +%F)测试生图或其他网关插件时,建议一个终端运行 hf plugin list --json,另一个终端跟随当天日志文件。前端插件通过 createPluginLogger() 写入的日志和 Rust 后端通过 ctx.log(...) 写入的日志会出现在同一条日志流里。
启动配置命令
Section titled “启动配置命令”使用桌面端里创建的 launch profile:
npm run hf -- launch list --jsonnpm run hf -- launch show "My Profile" --jsonnpm run hf -- launch run "My Profile" --jsonnpm run hf -- launch run "My Profile" --server local --jsonCatalog 管理命令
Section titled “Catalog 管理命令”Admin 命令面向 catalog 运营和发布人员:
npm run hf -- admin menpm run hf -- admin catalog list --kind plugin --status publishednpm run hf -- admin catalog item get dev.haloforge.markdownnpm run hf -- admin catalog version review dev.haloforge.markdown@0.2.2 approved --notes "Validated package and metadata."npm run hf -- admin catalog version publish dev.haloforge.markdown@0.2.2hf 和 hf-pack
Section titled “hf 和 hf-pack”| 工具 | 用途 |
|---|---|
hf | 操作本地 HaloForge workspace:安装本地插件包、列出插件、运行启动配置、执行 catalog admin 操作。 |
@haloforge/plugin-pack / hf-pack | 插件打包工具:校验 manifest、构建 .hfpkg、生成 catalog metadata、提交草稿。 |
普通插件测试流程会同时用到两者:
cd /path/to/pluginnpx --yes @haloforge/plugin-pack@0.2.13 check .npx --yes @haloforge/plugin-pack@0.2.13 pack . --out dist/package
cd /path/to/HaloForgenpm run hf -- plugin install local /path/to/plugin/dist/package/<plugin-id>-<version>.hfpkg --jsonnpm run hf -- plugin list --json