Skip to content

# 安装器内部机制

OpenSoul 提供三个安装器脚本(托管在 opensoul.ai):

脚本平台功能
install.shmacOS / Linux / WSL在需要时安装 Node,通过 npm(默认)或 git 安装 OpenSoul,并可运行新手引导。
install-cli.shmacOS / Linux / WSL将 Node + OpenSoul 安装到本地前缀目录(~/.opensoul)。无需 root 权限。
install.ps1Windows (PowerShell)在需要时安装 Node,通过 npm(默认)或 git 安装 OpenSoul,并可运行新手引导。

# 快速命令

# install.sh

bash
curl -fsSL https://opensoul.ai/install.sh | bash
bash
curl -fsSL https://opensoul.ai/install.sh | bash -s -- --help

# install-cli.sh

bash
curl -fsSL https://opensoul.ai/install-cli.sh | bash
bash
curl -fsSL https://opensoul.ai/install-cli.sh | bash -s -- --help

# install.ps1

powershell
iwr -useb https://opensoul.ai/install.ps1 | iex
powershell
& ([scriptblock]::Create((iwr -useb https://opensoul.ai/install.ps1))) -Tag beta -NoOnboard -DryRun

注意: 如果安装成功但在新终端中找不到 opensoul,请参见 Node.js 故障排除


# install.sh

提示: 推荐用于 macOS/Linux/WSL 上的大多数交互式安装。

# 流程 (install.sh)

# 检测操作系统

支持 macOS 和 Linux(包括 WSL)。如果检测到 macOS,则安装缺失的 Homebrew。

# 确保 Node.js 22+

检查 Node 版本并在需要时安装 Node 22(macOS 使用 Homebrew,Linux 使用 NodeSource 设置脚本)。

# 确保 Git

安装缺失的 Git。

# 安装 OpenSoul

  • npm 方式(默认):全局 npm 安装。
  • git 方式:克隆/更新仓库,使用 pnpm 安装依赖并构建,然后在 ~/.local/bin/opensoul 安装包装脚本。

# 后期安装任务

  • 在升级和 git 安装时运行 opensoul doctor --non-interactive
  • 在适当情况下尝试运行新手引导。
  • 默认设置 SHARP_IGNORE_GLOBAL_LIBVIPS=1

# 参数参考 (install.sh)

参数描述
`--install-method npmgit`
--npmnpm 方式快捷键
--gitgit 方式快捷键。别名:--github
`--version <versiondist-tag>`
--no-onboard跳过新手引导
--dry-run打印操作而不应用更改

# install-cli.sh

信息: 适用于希望将所有内容放在本地前缀目录(默认 ~/.opensoul)且不改动系统 Node 依赖的环境。

# 流程 (install-cli.sh)

# 安装本地 Node 运行时

下载 Node 压缩包(默认 22.22.0)到前缀目录下并验证。

# 安装 OpenSoul

使用 npm --prefix 安装 OpenSoul,然后写入包装脚本。

# 故障排除

# 为什么在 Linux 上 npm 会报 EACCES 错误?

某些 Linux 设置中,npm 全局前缀指向 root 拥有的路径。install.sh 可以将前缀切换到 ~/.npm-global 并更新 PATH。

# sharp/libvips 问题

脚本默认设置 SHARP_IGNORE_GLOBAL_LIBVIPS=1 以避免 sharp 针对系统 libvips 构建。

# Windows: "opensoul is not recognized"

运行 npm config get prefix,附加 \bin,将其添加到 PATH,然后重新打开 PowerShell。

Released under the MIT License.