Developer Preview — This project is in active development. APIs may change. Provide feedback
Skip to content

Installation

Prerequisites

  • macOS, Linux, or Windows
  • Node.js 22.0.0 or higher (for npm installation or SDK usage)

The easiest way to install the B2C CLI on macOS or Linux is via Homebrew:

bash
brew install salesforcecommercecloud/tools/b2c-cli

Or tap the repository first:

bash
brew tap salesforcecommercecloud/tools
brew install b2c-cli

Using a Brewfile

Add to your Brewfile:

ruby
tap "salesforcecommercecloud/tools"
brew "b2c-cli"

Then run:

bash
brew bundle

Install via npm

Not Yet Available

The B2C CLI is not yet published to npm. This installation method will be available in a future release. For now, please use Homebrew or download from GitHub Releases.

Install the CLI globally using your preferred package manager:

bash
npm install -g @salesforce/b2c-cli
bash
pnpm add -g @salesforce/b2c-cli
bash
yarn global add @salesforce/b2c-cli

Install from GitHub Releases

Download the latest release tarball from GitHub Releases and install manually:

bash
npm install -g ./salesforce-b2c-cli-<version>.tgz

Verify Installation

After installation, verify the CLI is available:

bash
b2c --version

Install the SDK (Optional)

Not Yet Available

The SDK is not yet published to npm. This installation method will be available in a future release.

If you want to use the SDK library in your own projects:

bash
npm install @salesforce/b2c-tooling-sdk
bash
pnpm add @salesforce/b2c-tooling-sdk
bash
yarn add @salesforce/b2c-tooling-sdk

Next Steps

All rights reserved.