commerce-b2b-open-code-components-integrate
forcedotcom/sf-skills
Integrate Salesforce B2B Commerce open source components into your store via Experience Builder.
What is commerce-b2b-open-code-components-integrate?
This skill clones the official Salesforce B2B Commerce open source components repository and copies all LWC components and labels into your B2B store's site metadata. Use it when you need to add pre-built open source commerce components to a new or existing B2B Commerce store.
- Clones the official forcedotcom/b2b-commerce-open-source-components repository
- Resolves your project's package directory from sfdx-project.json
- Retrieves B2B store metadata from your connected org if not already local
- Copies all open source LWC components into your store's site metadata
- Copies associated label files required by the components
- Makes components immediately available in Experience Builder
How to install commerce-b2b-open-code-components-integrate
npx skills add https://github.com/forcedotcom/sf-skills --skill commerce-b2b-open-code-components-integrate- Git CLI (version ≥2.0.0) installed
- Salesforce CLI (sf, version ≥2.0.0) installed
- An existing B2B Commerce store or ability to create one
- A connected Salesforce org with B2B Commerce enabled
How to use commerce-b2b-open-code-components-integrate
- 1.The skill automatically checks for and clones the open source repository if needed
- 2.It resolves your package directory from sfdx-project.json
- 3.It locates or retrieves your B2B store metadata from the connected org
- 4.It presents options if components already exist (overwrite all or copy only new)
- 5.It copies all LWC components and label files to your store's site metadata
- 6.After completion, deploy the changes and open Experience Builder to use the new components
Use cases
- Add pre-built B2B commerce components to a newly created store
- Integrate open source components into an existing B2B Commerce store
- Update components to the latest version from the official repository
- Populate Experience Builder with ready-to-use commerce UI components
- Salesforce B2B Commerce developers
- Commerce store administrators
- Experience Builder users building B2B storefronts
commerce-b2b-open-code-components-integrate FAQ
The skill detects existing components and offers two options: overwrite all with the latest from the repository, or copy only new components not yet present.
If no store metadata is found locally, the skill attempts to retrieve it from your connected org. If that fails, it delegates to the commerce-b2b-store-create skill to create one first.
All components are cloned from the official Salesforce repository at https://github.com/forcedotcom/b2b-commerce-open-source-components into a local .tmp/ folder, then copied into your store's site metadata.
After the skill completes, deploy the changes using sf project deploy start, then open Experience Builder for your store and the new components will appear in the component palette.
Yes, the skill offers an option to re-clone fresh from GitHub if the existing cloned repository is outdated or corrupted.
Full instructions (SKILL.md)
Source of truth, from forcedotcom/sf-skills.
name: commerce-b2b-open-code-components-integrate description: "Integrate Salesforce B2B Commerce open source components from GitHub into B2B Commerce stores. Use when users mention "integrate open code components", "open source B2B commerce", "add open code components", "forcedotcom/b2b-commerce-open-source-components", or want to add open source commerce components to their store. Copies all components and labels so they become available in Experience Builder." allowed-tools: Bash(git clone:) Bash(cp:) Bash(sf org list:) Bash(sf config get:) Bash(sf project retrieve start:*) Read metadata: version: "1.0" domains: ["Commerce", "Experience"] minApiVersion: "56.0" relatedSkills: - "commerce-b2b-store-create" cliTools: - tool: ["git"] semver: ">=2.0.0" - tool: ["sf"] semver: ">=2.0.0"
When to Use This Skill
Use this skill when you need to:
- Integrate all open source B2B Commerce components into a store
- Add open source components to a new or existing B2B Commerce store
- Make open code components available in Experience Builder
Rules
- Always explain before executing. Before running any command, you MUST tell the user what the command does and why you are running it. Never just show a raw command and ask for permission. The user should be able to read your explanation and understand the purpose before approving.
Overview
This skill copies all open source B2B Commerce components from the official Salesforce repository (https://github.com/forcedotcom/b2b-commerce-open-source-components) into a B2B Commerce store's site metadata. After integration, the components appear in the Experience Builder component palette.
Startup Flow
When this skill is triggered, perform these checks automatically before copying.
Check 0: Resolve Package Directory
Read sfdx-project.json and pick the active package directory. Extract packageDirectories[] and use the entry with "default": true; if no entry is flagged default, use the first entry. Use this value as <package-dir> everywhere below. If sfdx-project.json is missing or has no packageDirectories, tell the user and abort.
Check 1: Open Source Repository
Verify the repo is cloned at .tmp/b2b-commerce-open-source-components:
- If directory does not exist: Tell user: "I'm cloning the official B2B Commerce open source components repository from GitHub into a local
.tmp/folder. This gives us access to all the open code components." Then run:git clone https://github.com/forcedotcom/b2b-commerce-open-source-components .tmp/b2b-commerce-open-source-components - If directory exists and contains
force-app/main/default/sfdc_cms__lwcandsfdc_cms__label, present options:"Open source repository is already cloned. How would you like to proceed?"
- Reuse existing — Use the already cloned repository
- Re-clone — Remove and clone fresh from GitHub
- If directory exists but structure is invalid: Tell user: "The cloned repository has an unexpected structure. I'll remove it and clone a fresh copy." Then remove and re-clone.
- If clone fails: inform user and abort
Check 2: Store and Site Metadata
Verify a store is selected and site metadata is available locally:
- Tell user: "I'm checking if your project already has B2B store metadata locally."
Check if
<package-dir>/main/default/digitalExperiences/site/contains any store directories. - If store metadata exists: use it. If multiple stores found, ask user to select one.
- If no store metadata found: Try retrieving from the connected org before delegating:
- Run
sf org list(or checksf config get target-org) to find a connected org. Ask the user to confirm or pick one if more than one. - List
DigitalExperienceBundlesite bundles in that org withsf org list metadata --metadata-type DigitalExperienceBundle --target-org <alias>. Filter tosite/*entries. - If at least one site bundle exists, ask the user which to use, then run:
sf project retrieve start --metadata "DigitalExperienceBundle:site/<storeName>" --target-org <alias>The bundle lands at<package-dir>/main/default/digitalExperiences/site/<storeName>/. - Only if no connected org is available, or no site bundles are found, or retrieve fails: delegate to the commerce-b2b-store-create skill.
- Run
Required state after all checks:
- Package dir — the value resolved in Check 0 (e.g.,
force-app) - Store name — the selected
fullNamevalue (e.g.,My_B2B_Store1) - Site metadata path —
<package-dir>/main/default/digitalExperiences/site/<store-name>/ - Repo path —
.tmp/b2b-commerce-open-source-components/
Integration Task
Copy all components and labels from cloned repo to site directory:
- Source:
.tmp/b2b-commerce-open-source-components/force-app/main/default/sfdc_cms__lwc/*andsfdc_cms__label/*(the open source repo's own layout — alwaysforce-app) - Destination:
<package-dir>/main/default/digitalExperiences/site/<store-name>/sfdc_cms__lwc/andsfdc_cms__label/(<package-dir>resolved in Check 0)
Steps:
- Tell user: "I'm checking if open code components already exist in your store's site metadata." Check if destination directories already contain files.
- If files exist, present options:
"Components already exist in {store-name}. How would you like to proceed?"
- Overwrite all — Replace all existing components with latest from repo
- Copy only new — Skip existing components, copy only ones not yet present
- Tell user: "I'm now copying all open code LWC components from the cloned repository into your store's site metadata directory." Copy all component directories from source to destination.
- Tell user: "I'm copying the associated label files that these components need." Copy all label directories from source to destination.
- Report: "Copied X components and Y label sets"
Output:
Integration Complete!
Copied: X components and Y label sets to <store-name>
Next Steps:
1. Deploy: sf project deploy start -d <package-dir>/main/default/digitalExperiences/site/<store-name>
2. Open Experience Builder and use new components from the palette
3. Publish your site when ready
Example Interaction
User: "Integrate open code components to my store"
Agent: "I'm checking if the open source components repository is already cloned locally..."
Agent: (repo exists)
"Open source repository is already cloned. How would you like to proceed?"
- Reuse existing — Use the already cloned repository
- Re-clone — Remove and clone fresh from GitHub
User: "1"
Agent: "I'm checking if your project already has B2B store metadata locally..."
- [done] Found store metadata for My_B2B_Store1
Agent: "I'm checking if open code components already exist in your store's site metadata..."
Agent: (files exist)
"Components already exist in My_B2B_Store1. How would you like to proceed?"
- Overwrite all — Replace all existing components with latest from repo
- Copy only new — Skip existing components, copy only ones not yet present
User: "1"
Agent: "I'm now copying all open code LWC components from the cloned repository into your store's site metadata directory..." Agent: "I'm copying the associated label files that these components need..."
- [done] Copied 45 components and 38 label sets
Integration Complete!
Copied: 45 components and 38 label sets to My_B2B_Store1
Next Steps:
1. Deploy: sf project deploy start -d force-app/main/default/digitalExperiences/site/My_B2B_Store1
2. Open Experience Builder and use new components from the palette
3. Publish your site when ready
Error Handling
| Error | Message | Action |
|---|---|---|
| Store not found | "Store '{name}' not found in org." | List stores again |
| Git clone failed | "Failed to clone repository. Check internet connection." | Retry or abort |
| Invalid repo structure | "Repository structure has changed. Expected sfdc_cms__lwc and sfdc_cms__label." | Warn user, abort |
| File copy failed | "Failed to copy files. Check file permissions." | Show error details |
Verification Checklist
- Startup Flow completed: repo cloned, store metadata available
- Components copied to correct destination path (
sfdc_cms__lwc/) - Labels copied to correct destination path (
sfdc_cms__label/) - No file permission errors during copy
- Deployment command provided and user informed about testing
Related skills
More from forcedotcom/sf-skills and the wider catalog.

commerce-b2b-open-code-components-replace
Replace Salesforce B2B Commerce OOTB components with open source equivalents in site metadata.

commerce-b2b-store-create
Create Salesforce B2B Commerce stores and retrieve storefront metadata interactively.

configuring-connected-apps
Configure Salesforce OAuth flows, Connected Apps, and External Client Apps with security best practices.

connecting-datacloud
Manage Salesforce Data Cloud connections, connectors, and source system setup.

creating-b2b-commerce-store
Create B2B Commerce stores and retrieve storefront metadata via interactive workflow.

data360-activate
Manage Salesforce Data Cloud activations, targets, and downstream delivery of audiences and data actions.