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

Start a new Claude Code session. To install for the current project only, run it from your project directory with --scope project.

Manual MCP setup
bash
claude mcp add --transport stdio --scope user b2c-dx-mcp -- npx -y @salesforce/b2c-dx-mcp@latest

Start a new session. To configure the current project only, run it from your project directory with --scope project. 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

Run:

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

Start a new Gemini CLI session. To configure the current project only, run it from your project directory with --scope project. 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

Configuration Flags ​

FlagEnvironment VariableDescription
--configSFCC_CONFIGdw.json path, used without the global default; empty for none
--instance, -iSFCC_INSTANCENamed instance to select
--project-directorySFCC_PROJECT_DIRECTORYProject directory for configuration lookup
--dotenv-fileSFCC_DOTENV_FILEEnv file to use instead of the project's .env; empty for none

See Configuration for how these files are selected.

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 ​

Use Safety Mode to limit changes while investigating an issue, running automated scripts, or letting an assistant run CLI commands. It shares its settings with the IDE Extension and MCP tools.

Environment VariableValuesDescription
SFCC_SAFETY_LEVELNONE (default)No restrictions
NO_DELETEBlock DELETE operations
READ_ONLYBlock POST, PUT, PATCH, and DELETE requests
SFCC_SAFETY_CONFIRMtrue, 1Ask for approval instead of blocking requests under the selected level, where supported. Explicit block rules still block.
SFCC_SAFETY_CONFIGFile pathUse a shared safety configuration file.

Existing NO_UPDATE configurations still work, but this legacy setting allows many updates. See choosing a safety level before using it for new work.

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

Rules can allow specific tasks or ask for approval in a terminal. Commands that need approval stop in automated runs where nobody can answer. See the Safety Mode guide for setup examples and supported confirmations.

Other Environment Variables ​

Environment VariableDescription
B2C_SKIP_NEW_VERSION_CHECKSkip the new version availability check
SFCC_AGENTOverride AI agent detection (see below)

AI Agents ​

For everyone, b2c --help lists discovery commands (b2c commands search, b2c docs skill, b2c docs search), and topic and command help end with the skill that covers them.

The CLI detects when an AI coding agent (such as Claude Code, Cursor, Codex, Gemini CLI, GitHub Copilot, or OpenCode) runs it, using environment variables those tools set. When an agent is detected:

  • Interactive prompts are disabled. Commands that would ask for confirmation fail with a message that names the --force (or --yes) flag instead of waiting for input that never arrives. The same applies whenever no interactive terminal is available.
  • b2c --help adds an Agent Guidance section (read the task's skill with b2c docs skill, prefer --json, prompts are disabled); topic and command help add short Agent Notes.
  • The agent name is added to the HTTP User-Agent and to anonymous usage telemetry, so agent-driven usage can be measured. Agent session IDs are never sent; only a one-way hash is used to group commands from the same session.

Set SFCC_AGENT to override detection: SFCC_AGENT=0 treats the session as human-driven, and SFCC_AGENT=1 (or an agent name, such as SFCC_AGENT="My Agent") enables agent behavior for tools that are not detected automatically.

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
  • Commands Search - Find the CLI command for a task by keyword
  • 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

Find a command for a task:

bash
b2c commands search "deploy cartridges"