2. 安装启动
PilotDeck Web 端提供两种安装方法:一键安装或从源码安装(面向开发者)。
2.1 方法一:一键安装
2.1.1 macOS / Linux
打开“终端”,执行:
curl -fsSL https://raw.githubusercontent.com/OpenBMB/PilotDeck/main/install.sh | bash
安装脚本会检查 Git 和受支持的 Node.js 22 运行时,安装依赖并构建 Web 前端。在 Linux 上,脚本可在存在 sudo 和受支持包管理器时补充缺少的系统依赖;在 macOS 上,安装脚本会检查 Xcode Command Line Tools,请先运行 xcode-select --install 并完成安装;原生依赖编译还需要可用的 Python 3。
程序默认安装到:
~/.pilotdeck/app/
安装程序可能会直接启动 PilotDeck。如果终端已经显示 Web UI 地址,可直接在浏览器中打开。以后再次使用时,运行:
pilotdeck
默认访问地址为 http://localhost:3001,端口被占用时启动器会尝试其他端口,请以启动终端输出的地址为准。pilotdeck status 可查看安装信息和下次启动地址。使用结束后,回到运行服务的终端按 Ctrl+C 正常关闭。
2.1.2 Windows
打开普通用户权限的 PowerShell,执行:
powershell -ExecutionPolicy Bypass -c "irm https://raw.githubusercontent.com/OpenBMB/PilotDeck/main/install.ps1 | iex"
脚本会在 %USERPROFILE%\.pilotdeck 下安装 PilotDeck,检查 Node.js 22.13+ 和 node:sqlite,在可用时通过 winget 补充依赖,并在 %USERPROFILE%\.pilotdeck\bin 中生成 pilotdeck.cmd 启动器。Git LFS 的拉取失败可以无视。
安装完成后,脚本会启动 PilotDeck 并显示 Web UI 地址,但不会自动打开浏览器。可复制终端显示的地址,或运行:
Start-Process "http://localhost:3001"
以后再次使用时,请新开一个 PowerShell 窗口并运行:
pilotdeck
如果提示找不到 pilotdeck,可直接运行启动器:
& "$HOME\.pilotdeck\bin\pilotdeck.cmd"
默认访问地址为 http://localhost:3001,端口被占用时启动器会尝试其他端口,请以启动终端输出的地址为准。pilotdeck status 可查看运行状态。使用结束后,回到运行服务的 PowerShell 窗口按 Ctrl+C 正常关闭。
提示:一键安装使用 GitHub main 分支,重新运行安装命令会获取当前版本。
如果默认 Web 端口已被占用,可以换用其他端口启动,例如:
pilotdeck --port 8080
此时应访问终端实际显示的地址。Web 界面端口与 AI 代理的内部端口不同,不要混用。
2.2 方法二:源码安装
所有系统都需要 Node.js >=22.13.0 <23、Git、Python 3、系统编译工具和 ripgrep。Git LFS 只用于下载大型演示媒体,不是核心功能的必要条件。
2.2.1 macOS
第一步:安装系统工具。
安装 Xcode Command Line Tools:
xcode-select --install
如果使用 Homebrew,可安装 Git LFS 和 ripgrep:
brew install git-lfs ripgrep
再通过你常用的 Node.js 版本管理器安装 Node.js 22。例如使用 fnm:
curl -fsSL https://fnm.vercel.app/install | bash
# 重新打开终端后执行
fnm install 22
fnm use 22
node --version
node --version 必须显示 v22.13.0 或更高的 v22.x。Intel Mac 还应运行 node -p "process.arch",确认输出为 x64。
第二步:拉取源码。
在准备存放代码的目录中执行:
GIT_LFS_SKIP_SMUDGE=1 git clone https://github.com/OpenBMB/PilotDeck.git
cd PilotDeck
第三步:启用 pnpm。
node --version
corepack enable
如果当前 Node.js 环境没有 Corepack,可安装官方源码指南指定的 pnpm 版本:
npm install -g pnpm@10.32.1
pnpm --version
第四步:安装项目依赖。
仍在 PilotDeck 仓库根目录中执行:
corepack pnpm install --frozen-lockfile --filter pilotdeck --filter pilotdeck-ui
如果上一步使用了全局 pnpm,则改为执行:
pnpm install --frozen-lockfile --filter pilotdeck --filter pilotdeck-ui
如果安装原生依赖时提示 Python 缺少 distutils,可尝试指定系统 Python 后重新安装:
PYTHON=/usr/bin/python3 corepack pnpm install --frozen-lockfile --filter pilotdeck --filter pilotdeck-ui
第五步:启动 Web 服务。
源码安装不会生成全局 pilotdeck 命令。在仓库根目录中选择一种模式启动。
开发模式支持热更新,适合修改和调试源码:
cd ui
npm run dev
浏览器访问终端输出的开发地址,默认为 http://localhost:5173。端口被占用时,开发启动器会尝试其他端口。
生产模式适合正常体验和持续运行:
cd ui
npm run start
浏览器访问 http://localhost:3001。两种模式选择一种即可;保持启动终端运行,关闭服务时按 Ctrl+C。
2.2.2 Windows
Windows 源码安装有两条路径:推荐使用 WSL2 Ubuntu,也可选择原生 PowerShell。
2.2.2.1 WSL2 Ubuntu(推荐)
第一步:安装 WSL2 和 Ubuntu。
在管理员 PowerShell 中执行:
wsl --install -d Ubuntu
如果系统要求重启,请先重启并完成 Ubuntu 的首次用户设置。后续命令都在 Ubuntu 终端中执行,不是在 PowerShell 中执行。
第二步:在 Ubuntu 中安装系统工具和 Node.js。
sudo apt-get update
sudo apt-get install -y git git-lfs ripgrep build-essential python3
curl -fsSL https://fnm.vercel.app/install | bash
# 重新打开 Ubuntu 终端后执行
fnm install 22
fnm use 22
node --version
确认 Node.js 为 v22.13.0 或更高的 v22.x。
第三步:在 Ubuntu 中拉取源码。
GIT_LFS_SKIP_SMUDGE=1 git clone https://github.com/OpenBMB/PilotDeck.git
cd PilotDeck
第四步:启用 pnpm 并安装依赖。
corepack enable
corepack pnpm install --frozen-lockfile --filter pilotdeck --filter pilotdeck-ui
如果没有 Corepack,可改用:
npm install -g pnpm@10.32.1
pnpm install --frozen-lockfile --filter pilotdeck --filter pilotdeck-ui
第五步:在 Ubuntu 中启动 Web 服务。
在仓库根目录中选择一种模式。开发模式支持热更新:
cd ui
npm run dev
浏览器访问终端输出的开发地址,默认为 http://localhost:5173。端口被占用时,开发启动器会尝试其他端口。
生产模式适合正常体验和持续运行:
cd ui
npm run start
浏览器访问 http://localhost:3001。两种模式选择一种即可;保持 Ubuntu 终端运行,关闭服务时按 Ctrl+C。
2.2.2.2 原生 Windows PowerShell
第一步:安装系统工具。
在 PowerShell 中逐行执行:
winget install OpenJS.NodeJS.LTS
winget install Git.Git
winget install GitHub.GitLFS
winget install Python.Python.3.12
winget install BurntSushi.ripgrep.MSVC
winget install Microsoft.VisualStudio.2022.BuildTools --override "--wait --add Microsoft.VisualStudio.Workload.VCTools --includeRecommended"
安装完成后关闭并重新打开 PowerShell,再检查环境:
git lfs install
node --version
node -p "process.arch"
npm --version
git --version
python --version
rg --version
node --version 必须显示 v22.13.0 或更高的 v22.x,process.arch 应输出 x64。如果 winget 安装的 Node.js LTS 已经不是 v22.x,请先通过 Node.js 版本管理器或官方 x64 Node.js 22 压缩包切换版本。
第二步:拉取源码。
$env:GIT_LFS_SKIP_SMUDGE = "1"
git clone https://github.com/OpenBMB/PilotDeck.git
Set-Location PilotDeck
第三步:启用 pnpm。
corepack enable
如果当前环境没有 Corepack:
npm.cmd install -g pnpm@10.32.1
pnpm --version
第四步:安装项目依赖。
corepack pnpm install --frozen-lockfile --filter pilotdeck --filter pilotdeck-ui
如果使用的是全局 pnpm,则改为执行:
pnpm install --frozen-lockfile --filter pilotdeck --filter pilotdeck-ui
PowerShell 如果提示 npm.ps1 或 pnpm.ps1 因执行策略而无法加载,可分别改用 npm.cmd 或 pnpm.cmd。
第五步:启动 Web 服务。
在仓库根目录中选择一种模式。开发模式支持热更新:
Set-Location ui
npm.cmd run dev
浏览器访问终端输出的开发地址,默认为 http://localhost:5173。端口被占用时,开发启动器会尝试其他端口。
生产模式适合正常体验和持续运行:
Set-Location ui
npm.cmd run start
浏览器访问 http://localhost:3001。两种模式选择一种即可;保持 PowerShell 窗口运行,关闭服务时按 Ctrl+C。
以上各系统的拉取命令都通过 GIT_LFS_SKIP_SMUDGE=1 跳过大型演示媒体,不影响 PilotDeck 核心功能。之后如需这些文件,可在仓库根目录执行:
git lfs pull
依赖安装命令会按照仓库提交的 pnpm-lock.yaml 安装 Gateway 和 Web UI,并排除 Web 部署不需要的 Electron 打包依赖。不要用 npm install 替换。
源码方式首次启动时,如果没有找到有效的 ~/.pilotdeck/pilotdeck.yaml,Web UI 会先进入 Onboarding。保存模型服务商、API Key 和模型后,PilotDeck 会写入配置并自动启动 Gateway。
2.2.3 Linux
以下以 Debian/Ubuntu 为例;Fedora/RHEL 和 Arch Linux 的系统依赖命令也列在本步骤中。
第一步:安装系统工具。
Debian/Ubuntu:
sudo apt-get update
sudo apt-get install -y git git-lfs ripgrep build-essential python3
Fedora/RHEL:
sudo dnf install -y git git-lfs ripgrep gcc gcc-c++ make python3
Arch Linux:
sudo pacman -Sy --needed git git-lfs ripgrep base-devel python
再安装 Node.js 22。例如使用 fnm:
curl -fsSL https://fnm.vercel.app/install | bash
# 重新打开终端后执行
fnm install 22
fnm use 22
node --version
确认输出为 v22.13.0 或更高的 v22.x,不要使用 Node.js 23 或更高版本。
第二步:拉取源码。
GIT_LFS_SKIP_SMUDGE=1 git clone https://github.com/OpenBMB/PilotDeck.git
cd PilotDeck
第三步:启用 pnpm。
corepack enable
如果当前环境没有 Corepack:
npm install -g pnpm@10.32.1
pnpm --version
第四步:安装项目依赖。
corepack pnpm install --frozen-lockfile --filter pilotdeck --filter pilotdeck-ui
如果使用的是全局 pnpm,则改为执行:
pnpm install --frozen-lockfile --filter pilotdeck --filter pilotdeck-ui
第五步:启动 Web 服务。
在仓库根目录中选择一种模式。开发模式支持热更新:
cd ui
npm run dev
浏览器访问终端输出的开发地址,默认为 http://localhost:5173。端口被占用时,开发启动器会尝试其他端口。
生产模式适合正常体验和持续运行:
cd ui
npm run start
浏览器访问 http://localhost:3001。两种模式选择一种即可;保持启动终端运行,关闭服务时按 Ctrl+C。