Installation
Prerequisites
- macOS, Linux, or Windows
- Node.js 22.0.0 or higher (for npm installation or SDK usage)
Install via Homebrew (Recommended)
The easiest way to install the B2C CLI on macOS or Linux is via Homebrew:
bash
brew install salesforcecommercecloud/tools/b2c-cliOr tap the repository first:
bash
brew tap salesforcecommercecloud/tools
brew install b2c-cliUsing a Brewfile
Add to your Brewfile:
ruby
tap "salesforcecommercecloud/tools"
brew "b2c-cli"Then run:
bash
brew bundleInstall 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-clibash
pnpm add -g @salesforce/b2c-clibash
yarn global add @salesforce/b2c-cliInstall from GitHub Releases
Download the latest release tarball from GitHub Releases and install manually:
bash
npm install -g ./salesforce-b2c-cli-<version>.tgzVerify Installation
After installation, verify the CLI is available:
bash
b2c --versionInstall 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-sdkbash
pnpm add @salesforce/b2c-tooling-sdkbash
yarn add @salesforce/b2c-tooling-sdkNext Steps
- Configuration - Set up authentication and instance configuration