Skip to content

Latest commit

 

History

History
108 lines (76 loc) · 4.17 KB

File metadata and controls

108 lines (76 loc) · 4.17 KB
description B2C CLI command reference with global flags and authentication options for managing Salesforce Commerce Cloud instances.

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

Flag Environment Variable Description
--server, -s SFCC_SERVER B2C instance hostname
--webdav-server SFCC_WEBDAV_SERVER Secure WebDAV hostname
--code-version, -v SFCC_CODE_VERSION Code version

Authentication Flags

Flag Environment Variable Description
--client-id SFCC_CLIENT_ID OAuth client ID
--client-secret SFCC_CLIENT_SECRET OAuth client secret
--username, -u SFCC_USERNAME Username for Basic Auth
--password, -p SFCC_PASSWORD Password/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 Variable Values Description
SFCC_SAFETY_LEVEL NONE (default) No restrictions
NO_DELETE Block DELETE operations
NO_UPDATE Block DELETE and destructive operations (reset, stop, restart)
READ_ONLY Block all write operations (GET only)

Example:

# 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 Security Guide for detailed information.

Other Environment Variables

Environment Variable Description
B2C_SKIP_NEW_VERSION_CHECK Skip the new version availability check

Command Topics

Instance Operations

Services

Development

  • Scaffold Commands - Generate cartridges, controllers, hooks, and more from templates

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)

Utilities

  • Docs Commands - Search/read Script API docs and XSD schemas, and download docs from an instance
  • Auth Commands - Authentication and token management
  • Logging - Log levels, output formats, and environment variables

Getting Help

Get help for any command:

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