Skip to main content
skill CX Codex

commerce-b2b-open-code-components-integrate — Claude Code skill

Pulls Salesforce B2B Commerce open source components from GitHub into a store's site metadata so they show up in the Experience Builder palette.

Install into Claude Code · Skills CLI (Vercel) All methods and platforms ↓
npx skills add forcedotcom/sf-skills --skill commerce-b2b-open-code-components-integrate -a claude-code
Open on GitHub

What commerce-b2b-open-code-components-integrate does

The skill works from the official forcedotcom/b2b-commerce-open-source-components repository. It copies every LWC component plus the label sets those components rely on into your store's site directory. Deploy the result and the components appear in the Experience Builder palette.

A few checks run first. The skill reads sfdx-project.json and picks the active package directory: the entry marked "default": true, or the first one when nothing is flagged. It then looks for a clone at .tmp/b2b-commerce-open-source-components and for store metadata inside the project. Should the metadata be missing, it tries to pull the site bundle from a connected org with sf project retrieve start. With no org and no bundle, the job goes to the commerce-b2b-store-create skill.

You need git and sf at version 2.0.0 or higher, and the minimum API version is 56.0. No sfdx-project.json, or a file without packageDirectories, stops the skill before anything is copied. If components already sit in the store, it asks whether to overwrite them or bring in only the new ones.

What it helps with

  • move open source B2B Commerce components into a store's site metadata
  • retrieve a site bundle from a connected org when none exists locally
  • add only the components a store does not have yet
  • refresh existing components with the latest versions from the repository
  • surface the components in the Experience Builder palette after deploy

Example prompts for the agent

  • Add the open code components to my My_B2B_Store1 store
  • Clone the open source components repo and copy them into my site metadata
  • Update the store components with the latest versions from the repo

How to install commerce-b2b-open-code-components-integrate

1Skills CLI (Vercel)

npx skills add forcedotcom/sf-skills --skill commerce-b2b-open-code-components-integrate -a claude-code

2Manually: put the files in place

~/.claude/skills/commerce-b2b-open-code-components-integrate/SKILL.md

Copy the whole skill folder; for one project use .claude/skills/commerce-b2b-open-code-components-integrate/

Step by step, with commands for each platform: How to install skills in Claude Code: five ways

Questions about commerce-b2b-open-code-components-integrate

How do I install commerce-b2b-open-code-components-integrate in Claude Code?

Run npx skills add forcedotcom/sf-skills --skill commerce-b2b-open-code-components-integrate -a claude-code. The skill file lands at ~/.claude/skills/commerce-b2b-open-code-components-integrate/SKILL.md.

What does commerce-b2b-open-code-components-integrate do?

It copies all open source LWC components and label sets from forcedotcom/b2b-commerce-open-source-components into your store's site directory. After deploy they are available in Experience Builder.

What do I need for the skill to run?

git and sf at version 2.0.0 or higher, plus an active package directory in sfdx-project.json. The minimum API version is 56.0.

Source text

SKILL.md · Apache-2.0
---
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

1. **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`:

1. **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`
2. **If directory exists** and contains `force-app/main/default/sfdc_cms__lwc` and `sfdc_cms__label`, present options:
   > "Open source repository is already cloned. How would you like to proceed?"
   > 1. **Reuse existing** — Use the already cloned repository
   > 2. **Re-clone** — Remove and clone fresh from GitHub
3. **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.
4. **If clone fails:** inform user and abort

### Check 2: Store and Site Metadata

Verify a store is selected and site metadata is available locally:

1. 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.
2. **If store metadata exists:** use it. If multiple stores found, ask user to select one.
3. **If no store metadata found:** Try retrieving from the connected org before delegating:
   1. Run `sf org list` (or check `sf config get target-org`) to find a connected org. Ask the user to confirm or pick one if more than one.
   2. List `DigitalExperienceBundle` site bundles in that org with `sf org list metadata --metadata-type DigitalExperienceBundle --target-org <alias>`. Filter to `site/*` entries.
   3. 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>/`.
   4. **Only if no connected org is available, or no site bundles are found, or retrieve fails:** delegate to the **commerce-b2b-store-create** skill.

**Required state** after all checks:
- **Package dir** — the value resolved in Check 0 (e.g., `force-app`)
- **Store name** — the selected `fullName` value (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/*` and `sfdc_cms__label/*` (the open source repo's own layout — always `force-app`)
- **Destination:** `<package-dir>/main/default/digitalExperiences/site/<store-name>/sfdc_cms__lwc/` and `sfdc_cms__label/` (`<package-dir>` resolved in Check 0)

**Steps:**

1. Tell user: "I'm checking if open code components already exist in your store's site metadata."
   Check if destination directories already contain files.
2. If files exist, present options:
   > "Components already exist in **{store-name}**. How would you like to proceed?"
   > 1. **Overwrite all** — Replace all existing components with latest from repo
   > 2. **Copy only new** — Skip existing components, copy only ones not yet present
3. 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.
4. Tell user: "I'm copying the associated label files that these components need."
   Copy all label directories from source to destination.
5. Report: "Copied X components and Y label sets"

**Output:**
```text
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?"
> 1. **Reuse existing** — Use the already cloned repository
> 2. **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?"
> 1. **Overwrite all** — Replace all existing components with latest from repo
> 2. **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

```text
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

© forcedotcom · Apache-2.0 · forcedotcom/sf-skills

Similar skills

Everything for Backend and APIs →

From the same set167

commerce-b2b-store-create Walks you through creating a Commerce B2B store in Salesforce and pulls the generated storefront metadata into your repo. Useful when a storefront has to come out of an existing store. CX Codex +1 4,700installs mobile-platform-offline-validate Audits Lightning Web Components for Komaci offline priming compatibility in Salesforce mobile apps and generates code-level fixes. CX Codex +1 4,700installs mobile-platform-native-capabilities-integrate Guides an agent through building Salesforce LWCs that use native mobile features such as scanning, location, NFC, and payments. Use it for lightning/mobileCapabilities work. CX Codex +1 4,700installs commerce-b2b-open-code-components-replace Replaces out-of-the-box B2B Commerce components with open source equivalents in site metadata content.json. Or just reports the mappings when you don't want files touched. CX Codex +1 4,600installs platform-policy-rule-generate Writes PolicyRuleDefinition and PolicyRuleDefinitionSet metadata XML for Salesforce Data Cloud: schema, category tree and pre-deploy checks. CX Codex +1 4,100installs platform-custom-report-type-generate Guides the agent through authoring and validating Salesforce Custom Report Type metadata: base object, joins, exposed fields. Handy when a .reportType-meta.xml deploy fails. CX Codex +1 4,000installs platform-sharing-owd-configure Reads and changes Organization-Wide Defaults on Salesforce objects: shows current access levels and edits sharingModel in the object metadata. CX Codex +1 3,700installs platform-encryption-configure Skill for generating Salesforce Shield Platform Encryption metadata and evaluating key management architecture models. CX Codex +1 3,600installs

Project sponsors

Companies that keep this analytics open
Gold sponsor

Impressions, clicks and code copies — open statistics. We keep the numbers public for the same reason NeBlask itself is public. Become a sponsor