This page takes you through the installation and startup of PilotDeck Web client, model configuration and submission of the first task on your computer.
PilotDeck Web version needs to be installed and started on your computer or server first, and then accessed through a browser.
2. Installation Starts
PilotDeck Web provides two installation methods: one-click installation or installation from source code (for developers).
2.1 Method 1: One-Click Installation
2.1.1 macOS / Linux
Open "Terminal" and execute:
curl -fsSL https://raw.githubusercontent.com/OpenBMB/PilotDeck/main/install.sh | bash
The installation script checks for Git and a supported Node.js 22 runtime, installs dependencies and builds the web frontend. On Linux, the script can be found in sudo Supplement missing system dependencies when using a supported package manager; on macOS, the installation script checks for Xcode Command Line Tools, please run xcode-select --install and complete the installation; native dependency compilation also requires available Python 3.
The program is installed by default to:
~/.pilotdeck/app/
The installer may launch PilotDeck directly. If the terminal has displayed the Web UI address, it can be opened directly in the browser. To use it again later, run:
pilotdeck
The default access address is http://localhost:3001, when the port is occupied, the launcher will try other ports. Please refer to the address output by the startup terminal.pilotdeck status You can view the installation information and next startup address. After use, return to the terminal running the service and press Ctrl+C Normal shutdown.
2.1.2 Windows
Open PowerShell with normal user rights and execute:
powershell -ExecutionPolicy Bypass -c "irm https://raw.githubusercontent.com/OpenBMB/PilotDeck/main/install.ps1 | iex"
The script will be in %USERPROFILE%\.pilotdeck Install PilotDeck under, check Node.js 22.13+ and node:sqlite, passed when available winget Supplementary dependencies and in %USERPROFILE%\.pilotdeck\bin generated in pilotdeck.cmd launcher. Git LFS pull failures can be ignored.
Once installed, the script launches PilotDeck and displays the Web UI address, but does not automatically open the browser. You can copy the address displayed in the terminal, or run:
Start-Process "http://localhost:3001"
When using it again in the future, please open a new PowerShell window and run:
pilotdeck
If the prompt cannot be found pilotdeck, you can run the launcher directly:
& "$HOME\.pilotdeck\bin\pilotdeck.cmd"
The default access address is http://localhost:3001, when the port is occupied, the launcher will try other ports. Please refer to the address output by the startup terminal.pilotdeck status You can check the running status. After use, return to the PowerShell window running the service and press Ctrl+C Normal shutdown.
Tip: One-click installation using GitHub main Branch, re-run the installation command to get the current version.
If the default Web port is already occupied, you can use another port to start, for example:
pilotdeck --port 8080
At this time, the address actually displayed on the terminal should be accessed. The web interface port is different from the AI agent's internal port, do not mix them.
2.2 Method 2: Source Code Installation
All systems require Node.js >=22.13.0 <23, Git, Python 3, system compilation tools and ripgrep. Git LFS is only used for downloading large presentation media and is not required for core functionality.
2.2.1 macOS
Step one: Install system tools.
Install Xcode Command Line Tools:
xcode-select --install
If using Homebrew, install Git LFS and ripgrep:
brew install git-lfs ripgrep
Then install Node.js 22 through your usual Node.js version manager. For example using fnm:
curl -fsSL https://fnm.vercel.app/install | bash
# Execute after reopening the terminal
fnm install 22
fnm use 22
node --version
node --version must be displayed v22.13.0 or higher v22.x. Intel Macs should also run node -p "process.arch", confirm the output is x64。
Step 2: Pull the source code.
Execute in the directory where the code is to be stored:
GIT_LFS_SKIP_SMUDGE=1 git clone https://github.com/OpenBMB/PilotDeck.git
cd PilotDeck
Step 3: Enable pnpm.
node --version
corepack enable
If the current Node.js environment does not have Corepack, you can install the pnpm version specified in the official source code guide:
npm install -g pnpm@10.32.1
pnpm --version
Step 4: Install project dependencies.
still PilotDeck Execute in the warehouse root directory:
corepack pnpm install --frozen-lockfile --filter pilotdeck --filter pilotdeck-ui
If you used global pnpm in the previous step, do this instead:
pnpm install --frozen-lockfile --filter pilotdeck --filter pilotdeck-ui
If you are prompted that Python is missing when installing native dependencies distutils, you can try to specify the system Python and reinstall it:
PYTHON=/usr/bin/python3 corepack pnpm install --frozen-lockfile --filter pilotdeck --filter pilotdeck-ui
Step 5: Start the Web service.
Source code installation will not generate a global pilotdeck command. Select a mode to start in the repository root directory.
Development mode supports hot updates and is suitable for modifying and debugging source code:
cd ui
npm run dev
The development address output by the browser access terminal, the default is http://localhost:5173. When a port is occupied, the development launcher tries other ports.
Production mode is suitable for normal experience and continuous operation:
cd ui
npm run start
Browser access http://localhost:3001. Just choose one of the two modes; keep the startup terminal running, and press when closing the service Ctrl+C。
2.2.2 Windows
There are two paths for Windows source installation: WSL2 Ubuntu is recommended, or native PowerShell is available.
2.2.2.1 WSL2 Ubuntu (recommended)
Step 1: Install WSL2 and Ubuntu.
Execute in Administrator PowerShell:
wsl --install -d Ubuntu
If the system requires a reboot, please reboot first and complete the first-time user setup of Ubuntu. Subsequent commands are executed in the Ubuntu terminal, not in PowerShell.
Step 2: Install system tools and Node.js in Ubuntu.
sudo apt-get update
sudo apt-get install -y git git-lfs ripgrep build-essential python3
curl -fsSL https://fnm.vercel.app/install | bash
# Reopen the Ubuntu terminal and execute
fnm install 22
fnm use 22
node --version
Confirm Node.js is v22.13.0 or higher v22.x。
Step 3: Pull the source code in Ubuntu.
GIT_LFS_SKIP_SMUDGE=1 git clone https://github.com/OpenBMB/PilotDeck.git
cd PilotDeck
Step 4: Enable pnpm and install dependencies.
corepack enable
corepack pnpm install --frozen-lockfile --filter pilotdeck --filter pilotdeck-ui
If you don't have Corepack, you can use:
npm install -g pnpm@10.32.1
pnpm install --frozen-lockfile --filter pilotdeck --filter pilotdeck-ui
Step 5: Start the web service in Ubuntu.
Select a schema in the repository root directory. Development mode supports hot updates:
cd ui
npm run dev
The development address output by the browser access terminal, the default is http://localhost:5173. When a port is occupied, the development launcher tries other ports.
Production mode is suitable for normal experience and continuous operation:
cd ui
npm run start
Browser access http://localhost:3001. Just choose one of the two modes; keep the Ubuntu terminal running, and press when closing the service Ctrl+C。
2.2.2.2 Native Windows PowerShell
Step one: Install system tools.
Execute line by line in 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"
After the installation is complete, close and reopen PowerShell and check the environment again:
git lfs install
node --version
node -p "process.arch"
npm --version
git --version
python --version
rg --version
node --version must be displayed v22.13.0 or higher v22.x,process.arch should be output x64. if winget The installed Node.js LTS is no longer v22.x, please first switch the version through the Node.js version manager or the official x64 Node.js 22 compressed package.
Step 2: Pull the source code.
$env:GIT_LFS_SKIP_SMUDGE = "1"
git clone https://github.com/OpenBMB/PilotDeck.git
Set-Location PilotDeck
Step 3: Enable pnpm.
corepack enable
If the current environment does not have Corepack:
npm.cmd install -g pnpm@10.32.1
pnpm --version
Step 4: Install project dependencies.
corepack pnpm install --frozen-lockfile --filter pilotdeck --filter pilotdeck-ui
If you are using global pnpm, execute instead:
pnpm install --frozen-lockfile --filter pilotdeck --filter pilotdeck-ui
PowerShell if prompted npm.ps1 or pnpm.ps1 Unable to load due to execution policy, can be used separately npm.cmd or pnpm.cmd。
Step 5: Start the Web service.
Select a schema in the repository root directory. Development mode supports hot updates:
Set-Location ui
npm.cmd run dev
The development address output by the browser access terminal, the default is http://localhost:5173. When a port is occupied, the development launcher tries other ports.
Production mode is suitable for normal experience and continuous operation:
Set-Location ui
npm.cmd run start
Browser access http://localhost:3001. Just choose one of the two modes; keep the PowerShell window running, and press when closing the service Ctrl+C。
The pull commands for each of the above systems all pass GIT_LFS_SKIP_SMUDGE=1 Skip large presentation media without affecting core PilotDeck functionality. If you need these files later, you can execute:
git lfs pull
Dependency installation commands will be submitted according to the warehouse pnpm-lock.yaml Install Gateway and Web UI, and exclude Electron packaging dependencies that are not required for web deployment. Don't use npm install Replace.
When starting in source code mode for the first time, if no valid ~/.pilotdeck/pilotdeck.yaml, the Web UI will enter Onboarding first. After saving the model service provider, API Key, and model, PilotDeck will write the configuration and automatically start the Gateway.
2.2.3 Linux
The following takes Debian/Ubuntu as an example; the system dependency commands of Fedora/RHEL and Arch Linux are also listed in this step.
Step one: Install system tools.
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
Then install Node.js 22. For example using fnm:
curl -fsSL https://fnm.vercel.app/install | bash
# Execute after reopening the terminal
fnm install 22
fnm use 22
node --version
Confirm the output is v22.13.0 or higher v22.x, do not use Node.js 23 or higher.
Step 2: Pull the source code.
GIT_LFS_SKIP_SMUDGE=1 git clone https://github.com/OpenBMB/PilotDeck.git
cd PilotDeck
Step 3: Enable pnpm.
corepack enable
If the current environment does not have Corepack:
npm install -g pnpm@10.32.1
pnpm --version
Step 4: Install project dependencies.
corepack pnpm install --frozen-lockfile --filter pilotdeck --filter pilotdeck-ui
If you are using global pnpm, execute instead:
pnpm install --frozen-lockfile --filter pilotdeck --filter pilotdeck-ui
Step 5: Start the Web service.
Select a schema in the repository root directory. Development mode supports hot updates:
cd ui
npm run dev
The development address output by the browser access terminal, the default is http://localhost:5173. When a port is occupied, the development launcher tries other ports.
Production mode is suitable for normal experience and continuous operation:
cd ui
npm run start
Browser access http://localhost:3001. Just choose one of the two modes; keep the startup terminal running, and press when closing the service Ctrl+C。