Skip to content

Install SF Pi ​

SF Pi runs inside the pi coding agent. Follow this one-time setup in order.

Requirements ​

  • Node.js >=22.19
  • the npm version bundled with a supported Node.js installation; SF Pi declares no separate npm floor
  • pi coding agent >=1.5.1 <2.0.0
  • a Salesforce CLI installation appropriate for the host platform

1. Install Node.js and npm ​

Install Node.js 22.19 or newer and verify the bundled npm client:

bash
node --version
npm --version

2. Review optional npm release-age policy ​

Some managed npm 11+ configurations delay newly published packages. If npm config get min-release-age reports a nonzero value and you intentionally want immediate Pi/package availability, set the user-level value to zero:

bash
npm config get min-release-age
npm config set min-release-age 0 --location=user
npm config get min-release-age

This is an optional user-wide npm policy, not an SF Pi runtime requirement. Older npm clients that do not expose this setting can skip this step. See npm's min-release-age documentation for details.

3. Install the latest Pi and SF Pi ​

Pi's managed installer pins its dependencies and is the recommended installation path:

bash
curl -fsSL https://pi.dev/install.sh | sh
pi --version
pi install git:github.com/salesforce/sf-pi

An npm installation remains supported but does not pin Pi's transitive dependencies:

bash
npm install --global --ignore-scripts @earendil-works/pi-coding-agent

SF Pi's supported Pi range is >=1.5.1 <2.0.0; exact Pi 1.5.2 is the latest audited and recommended runtime. Pi owns Pi Runtime update guidance, while /sf-pi doctor reports compatibility and installation details.

4. Install or update Salesforce CLI ​

Use npm as the single installation and update path:

bash
npm install --global @salesforce/cli@latest
sf --version

See the official Salesforce CLI installation guide for platform support and verification details.

5. Start Pi and verify the installation ​

Run Pi from the project directory where you want to work:

bash
pi

Then enter:

text
/reload
/sf-pi doctor

6. Install Salesforce skills ​

sf-skills is already bundled with SF Pi. Install the managed Salesforce skill library globally so it is available in every project:

text
/sf-skills defaults install global
/sf-skills summary

Install the complete curated package bundle:

text
/sf-pi recommended install bundle:default
/sf-pi recommended status

A successful setup has:

  • /sf-pi doctor reporting no blocking installation problem;
  • sf --version printing the installed Salesforce CLI version;
  • /sf-skills summary showing the managed Salesforce skills; and
  • /sf-pi recommended status showing the curated bundle decisions.
Advanced setup and manual updates

Project-only SF Pi installation ​

The standard installation is global. To make SF Pi available only in the current project, use:

bash
pi install -l git:github.com/salesforce/sf-pi

Terminal font ​

If terminal glyphs appear as ?, run:

text
/sf-setup-fonts

Then select MesloLGM Nerd Font Mono in your terminal and reopen it.

Manual updates ​

Update the three core installations with:

bash
pi update --self
pi update git:github.com/salesforce/sf-pi
npm install --global @salesforce/cli@latest

Restart Pi or run /reload, then verify with /sf-pi doctor.

Platform notes ​

Required CI continuously proves Ubuntu with Node 22, and the required Tests (Windows) job runs the type check and full unit suite on native Windows for every pull request and release. SF Pi launches Windows .cmd CLIs (sf, npm, pi, agent-browser) and opens URLs without a shell. macOS paths are documented but not a required CI job. On Windows, some installers (for example the Nerd Font) still use manual steps, and a few POSIX-only features such as owner-only file modes rely on the user profile's ACLs instead.

Maintained support evidence ​

ClaimMaintained proof
Node.js >=22.19package.json engines, preinstall check, doctor diagnostics, and required Ubuntu CI
Pi >=1.5.1 <2.0.0peer dependency, runtime-floor checks, and nightly exact-version compatibility jobs
npm clientno independent engine/package-manager floor; required CI uses the npm bundled by Node 22
Operating systemsrequired CI proves Ubuntu and native Windows; macOS paths are documented at their proof level

Next step ​

Continue with the Quickstart.

Released under the Apache-2.0 License.