b2c-sites
List storefront sites, check site status, and manage cartridge paths on B2C Commerce instances using the b2c CLI. Use this skill whenever the user needs to discover site IDs, check which storefronts are online or offline, get site configuration as JSON, or view/modify the ordered cartridge path for a site or Business Manager. Also use when the user needs site information for scripting, CI/CD pipelines, or as input to other commands — even if they just say "what sites do I have" or "add this cartridge to my site".
How do I install this agent skill?
npx skills add https://github.com/salesforcecommercecloud/b2c-developer-tooling --skill b2c-sitesIs this agent skill safe to install?
- Gen Agent Trust Hubpass
This skill provides commands to manage Salesforce B2C Commerce sites. It is generally safe but contains a surface for indirect prompt injection where user-supplied inputs are used in shell commands without explicit sanitization instructions.
- Socketpass
No alerts
- Snykpass
Risk: LOW · No issues
- Runlayerpass
1/1 file flagged
What does this agent skill do?
B2C Sites Skill
Use the b2c CLI plugin to list and manage storefront sites on Salesforce B2C Commerce instances.
Tip: If
b2cis not installed globally, usenpx @salesforce/b2c-cliinstead (e.g.,npx @salesforce/b2c-cli sites list).
Configuration & Authentication
The CLI auto-discovers the target instance and credentials from SFCC_* environment variables (including project .env), the selected project-local or shared dw.json, and configuration plugins. package.json supplies only non-sensitive defaults. Flags like --server, --client-id, and --client-secret are usually unnecessary — only pass them to override what's auto-detected.
Run b2c setup inspect to see the resolved configuration and which source provided each value (use --json for scripting; secrets stay masked by default). For precedence rules and troubleshooting, see the b2c-cli:b2c-config skill.
Commands
b2c sites list
Lists all sites on a B2C Commerce instance, showing site ID, display name, and storefront status.
# list all sites on the configured instance
b2c sites list
# list sites on a specific server
b2c sites list --server my-sandbox.demandware.net
# list sites with JSON output (useful for parsing/automation)
b2c sites list --json
# use a specific instance from config
b2c sites list --instance production
# enable debug logging
b2c sites list --debug
Cartridge Path Management
Manage the ordered list of active cartridges on a site. The singular alias sites cartridge also works.
# list the cartridge path for a storefront site
b2c sites cartridges list --site-id RefArch
# list the Business Manager cartridge path
b2c sites cartridges list --bm
# add a cartridge to the beginning of a site's path (default)
b2c sites cartridges add plugin_applepay --site-id RefArch
# add a cartridge to the end
b2c sites cartridges add plugin_applepay --site-id RefArch --position last
# add a cartridge after a specific cartridge
b2c sites cartridges add plugin_applepay --site-id RefArch --position after --target app_storefront_base
# add a cartridge to Business Manager
b2c sites cartridges add bm_extension --bm --position first
# remove a cartridge from a site
b2c sites cartridges remove old_cartridge --site-id RefArch
# replace the entire cartridge path
b2c sites cartridges set "app_storefront_base:plugin_applepay:plugin_wishlists" --site-id RefArch
# JSON output for automation
b2c sites cartridges list --site-id RefArch --json
What the listed path contains. list (and the cartridges field of sites list --json) shows the effective path: your custom cartridges, followed by the platform plugin cartridges the instance appends (for example payment plugins). Pass only your own cartridges to set; copying the full listed path adds the platform cartridges a second time. To check a path in a script, compare its leading entries.
Site archive imports reset the path. A sites/<site-id>/site.xml imported without <custom-cartridges> clears the site's cartridge path. Include <custom-cartridges> in any site.xml you import (for example, one that only changes the storefront status), or set the path again afterwards.
Site and Business Manager cartridge paths replicate from staging with the site (b2c-cli:b2c-replication), so on production and development set them on staging and replicate.
When OCAPI direct permissions for /sites/*/cartridges are unavailable, cartridge commands automatically fall back to site archive import/export. Business Manager (--bm) updates use SCAPI (sfcc.sites.rw), then site archive import; OCAPI can't update the BM site.
Key flags (inherited from InstanceCommand):
| Flag | Short | Description |
|---|---|---|
--server | -s | B2C instance hostname (env: SFCC_SERVER) |
--json | Output full site data as JSON | |
--instance | Named instance from config | |
--debug | Enable debug logging |
Output columns: ID, Display Name, Status (storefront_status).
JSON output returns the full site objects including all properties (useful for extracting channel IDs, custom preferences, and other site metadata not shown in the table).
Site reads and cartridge-path writes run over SCAPI (the site/sites API) when shortCode, tenantId, and the sfcc.sites / sfcc.sites.rw scopes are configured. auto temporarily falls back to deprecated OCAPI on safe SCAPI rejections, and writes can fall back again to site archive import when direct APIs are unavailable.
Common Use Cases
Finding site IDs for other commands: Many commands (e.g., site import/export) require a site ID. Use sites list to discover valid IDs:
b2c sites list
# then use the ID in other commands
b2c job export --site RefArch --site-data content,site_preferences
Checking site status: The status column shows the storefront status (online/offline) for each site, useful for verifying deployment state.
Scripting and automation: Use --json to get machine-readable output for CI/CD pipelines:
b2c sites list --json | jq '.data[].id'
Related Skills
- b2c-config -- configure instances, credentials, and debug connection issues
- b2c-site-import-export -- import/export site archives and metadata XML
How can the creator link this skill?
Add the canonical catalog link to the repository README so users can inspect current installs and available audits. The publishing guide covers the complete discovery path.
<a href="https://skillzs.dev/skills/salesforcecommercecloud/b2c-developer-tooling/b2c-sites">View b2c-sites on skillZs</a>