无极开物Docs

安装配置

安装 hstack,选择工作区,并初始化 main/dev 检出。

前置要求

  • Node.js
  • Yarn
  • Docker(如果计划使用 KAIWU-server 完整版本,建议安装)
  • Tailscale(可选,推荐用于手机或远程访问)

安装与初始化

运行 hstack 有以下几种方式:

  • 作为已安装的 CLI 运行(发布后的推荐方式)
  • 通过 npx 运行(适合一次性配置)
  • 从本地检出代码运行(适合维护者,或 npm 包尚未发布时)

引导式设置(推荐)

开发配置(推荐贡献者使用):

hstack setup-from-source --profile=dev

自托管配置(稳定/类生产环境):

kaiwu relay host install --mode system

旧版包装脚本(仍受支持):

hstack self-host install # forwards to `kaiwu relay host install` when supported

在安装时启用自动更新(需手动开启):

hstack self-host install --auto-update --auto-update-at=03:15

安装完成后也可以调整更新计划:

hstack self-host config set --auto-update --auto-update-at=03:15

旧版别名(仍受支持):

hstack setup --profile=selfhost # deprecated; use setup-from-source or self-host install
hstack setup-from-source --profile=selfhost

使用其他稳定分支

默认情况下,setup-from-source 会使用 main 检出稳定的 main/ 工作区。若要指定其他分支(例如 preview):

hstack setup-from-source --profile=selfhost --stable-branch=preview

此操作会将 KAIWU_STACK_STABLE_BRANCH 保存在用户配置中,以便后续的初始化引导与审查流程继续使用该分支。

选择工作区目录

工作区用于存放 hstack 的以下内容:

  • main/(稳定分支检出;请视为只读)
  • dev/(用于开发的 dev 分支检出)
  • 按类别划分的工作树:
    • pr/…
    • local/⟦K12⟧/…
    • tmp/⟦K13⟧/…

可以显式指定目录:

hstack setup-from-source --profile=dev --workspace-dir=~/Documents/Development/kaiwu

或者通过环境变量设置:

export KAIWU_STACK_WORKSPACE_DIR=~/Documents/Development/kaiwu

开发 hstack 本身(本地 CLI 根目录)

在 monorepo 内迭代 hstack 源码时,可以将已安装的垫片(shim)指向本地检出的代码:

export KAIWU_STACK_CLI_ROOT_DIR=~/Documents/Development/kaiwu/dev/apps/stack
hstack help

若要确认当前设备上 hstack 实际使用的版本与路径,请运行:

hstack where
© 乾元执中(南京)科技有限公司 · WUJI-Labs

On this page