Install AI Tools

B2C Commerce tools, documentation, and skills for your assistant.

Claude

Install the plugin Recommended

bash
claude plugin marketplace add SalesforceCommerceCloud/b2c-developer-tooling
claude plugin install b2c-dx-mcp@b2c-developer-tooling --scope project

Start a new Claude Code session in your project. Use --scope user instead for all projects.

Manual MCP setup

From your project directory:

bash
claude mcp add --transport stdio --scope project b2c-dx-mcp -- npx -y @salesforce/b2c-dx-mcp@latest

Start a new session. Use --scope user instead for all projects. See Claude Code MCP setup.

Claude Desktop setup

Codex

Install the plugin Recommended

bash
codex plugin marketplace add SalesforceCommerceCloud/b2c-developer-tooling
codex plugin add b2c-dx-mcp@b2c-developer-tooling

Start a new Codex session in your project. This setup also works with the Codex IDE extension and the ChatGPT Work desktop app.

Manual MCP setup
bash
codex mcp add b2c-dx-mcp -- npx -y @salesforce/b2c-dx-mcp@latest

Or add this to ~/.codex/config.toml (or $CODEX_HOME/config.toml if customized):

toml
[mcp_servers.b2c-dx-mcp]
command = "npx"
args = ["-y", "@salesforce/b2c-dx-mcp@latest"]

Start a new session. See Codex MCP configuration.

ChatGPT online setup

VS Code

Install the plugin Recommended

  1. Open the Command Palette (Cmd/Ctrl+Shift+P) and run Chat: Install Plugin from Source.
  2. Enter SalesforceCommerceCloud/b2c-developer-tooling.
  3. Select b2c-dx-mcp and follow the installation prompts.
  4. Start a new chat in GitHub Copilot.
Manual MCP setup

Add this to .vscode/mcp.json in your workspace:

json
{
  "servers": {
    "b2c-dx-mcp": {
      "type": "stdio",
      "command": "npx",
      "args": ["-y", "@salesforce/b2c-dx-mcp@latest"]
    }
  }
}

See VS Code MCP setup.

Copilot CLI setup

Cursor

Reload the MCP server in Cursor after installation.

Manual MCP setup

Add this to .cursor/mcp.json in your project:

json
{
  "mcpServers": {
    "b2c-dx-mcp": {
      "command": "npx",
      "args": ["-y", "@salesforce/b2c-dx-mcp@latest"]
    }
  }
}

For all projects, use ~/.cursor/mcp.json instead.

See Cursor's MCP documentation.

OpenCode

Add this to opencode.json in your project:

json
{
  "mcp": {
    "b2c-dx-mcp": {
      "type": "local",
      "command": ["npx", "-y", "@salesforce/b2c-dx-mcp@latest"],
      "enabled": true
    }
  }
}

Restart OpenCode. For all projects, use ~/.config/opencode/opencode.json. See OpenCode MCP setup.

Gemini

From your project directory, run:

bash
gemini mcp add --scope project b2c-dx-mcp -- npx -y @salesforce/b2c-dx-mcp@latest

Start a new Gemini CLI session. Use --scope user instead for all projects. See Gemini CLI MCP setup.

No separate skills plugins needed.

Other clients and manual setup →
Skip to content
View as Markdown
View as Markdown

CLI Reference

The b2c CLI provides commands for managing Salesforce B2C Commerce instances.

Global Flags

These flags are available on all commands that interact with B2C instances:

Instance Flags

FlagEnvironment VariableDescription
--server, -sSFCC_SERVERB2C instance hostname
--webdav-serverSFCC_WEBDAV_SERVERSecure WebDAV hostname
--code-version, -vSFCC_CODE_VERSIONCode version

Authentication Flags

FlagEnvironment VariableDescription
--client-idSFCC_CLIENT_IDOAuth client ID
--client-secretSFCC_CLIENT_SECRETOAuth client secret
--username, -uSFCC_USERNAMEUsername for Basic Auth
--password, -pSFCC_PASSWORDPassword/access key for Basic Auth

Safety Mode

Safety Mode provides protection against accidental or unwanted destructive operations. This is particularly important when using the CLI in automated environments, CI/CD pipelines, or as a tool for AI agents.

Environment VariableValuesDescription
SFCC_SAFETY_LEVELNONE (default)No restrictions
NO_DELETEBlock DELETE operations
NO_UPDATEBlock DELETE and destructive operations (reset, stop, restart)
READ_ONLYBlock all write operations (GET only)
SFCC_SAFETY_CONFIRMtrue, 1Enable confirmation mode (prompt user instead of blocking destructive operations)
SFCC_SAFETY_CONFIGFile pathPath to global safety config file (JSON format with optional level, confirm, and rules)

Example:

bash
# Prevent deletions in CI/CD
export SFCC_SAFETY_LEVEL=NO_DELETE
b2c sandbox create --realm test  # ✅ Allowed
b2c sandbox delete test-id       # ❌ Blocked

# Read-only mode for reporting
export SFCC_SAFETY_LEVEL=READ_ONLY
b2c sandbox list                 # ✅ Allowed
b2c sandbox create --realm test  # ❌ Blocked

Safety Mode operates at the HTTP layer and cannot be bypassed by command-line flags. See the Safety Mode guide for detailed information.

Other Environment Variables

Environment VariableDescription
B2C_SKIP_NEW_VERSION_CHECKSkip the new version availability check

Command Topics

Instance Operations

Services

Development

  • Scaffold Commands - Generate cartridges, controllers, hooks, and more from templates
  • Debug Command - Start a DAP adapter for IDE-driven script debugging

Account Management

All Account Manager commands are under the am topic:

  • b2c am users ... - User management commands
  • b2c am roles ... - Role management commands
  • b2c am orgs ... - Organization management commands
  • b2c am clients ... - API client management (list, get, create, update, delete, password)

Setup & Utilities

  • Setup Commands - Configure instances, install IDE integrations, and install agent skills
  • Auth Commands - Authentication and token management
  • Docs Commands - Search/read Script API, Developer Center guides, tooling docs, job steps, and XSD schemas; download docs from an instance
  • Logging - Log levels, output formats, and environment variables

Getting Help

Get help for any command:

bash
b2c --help
b2c code --help
b2c code deploy --help