b2c-developer-tooling

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

b2c-developer-tooling

★ 51 Open GitHub ↗

B2C CLI, VSCode Extension, Skills+MCP, and Tooling SDK for Salesforce Agentforce Commerce B2C

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# B2C CLI, MCP and Tooling SDK

[![CI](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/actions/workflows/ci.yml/badge.svg)](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/actions/workflows/ci.yml)

> [!NOTE]
> This project is **Generally Available (GA)**. Please provide feedback via GitHub issues.

Salesforce B2C Commerce Command Line Tools.

> [!TIP]
> **Just looking for the B2C CLI or MCP install instructions?** Visit the documentation site at [https://salesforcecommercecloud.github.io/b2c-developer-tooling/](https://salesforcecommercecloud.github.io/b2c-developer-tooling/) for the latest install guide and CLI reference.

## Agent Skills & Plugins

Install B2C Commerce agent skills and plugins in your AI-powered editor. Three plugins are available: `b2c-cli` (CLI operations), `b2c` (development patterns), and `b2c-dx-mcp` (MCP server — Claude Code only).

- **Claude Code**: run these commands in chat:

```
    /plugin marketplace add SalesforceCommerceCloud/b2c-developer-tooling
    /plugin install b2c-cli@b2c-developer-tooling
    /plugin install b2c@b2c-developer-tooling
    /plugin install b2c-dx-mcp@b2c-developer-tooling
    ```

- **VS Code (GitHub Copilot)**: Command Palette (`Cmd+Shift+P` / `Ctrl+Shift+P`) → **Chat: Install Plugin From Source** → enter the repo `SalesforceCommerceCloud/b2c-developer-tooling`.

- **GitHub Copilot CLI**:

```
    copilot plugin marketplace add SalesforceCommerceCloud/b2c-developer-tooling
    copilot plugin install b2c-cli@b2c-developer-tooling
    copilot plugin install b2c@b2c-developer-tooling
    ```

- **Cursor**: add the marketplace from this repo URL in Cursor Settings → Plugins, then install `b2c-cli` / `b2c`.

- **Codex CLI**: run `/plugins` and add from this repo (GitHub URL).

- **Gemini CLI**: `gemini extensions install https://github.com/SalesforceCommerceCloud/b2c-developer-tooling`

- **Any supported IDE (file-copy install via CLI)**:

```
    npx @salesforce/b2c-cli setup skills
    ```

For Windsurf, OpenCode, Agentforce Vibes, manual installs, and the full install matrix, see [docs/guide/agent-skills](https://salesforcecommercecloud.github.io/b2c-developer-tooling/guide/agent-skills).

## Packages

This is a pnpm monorepo with the following packages:

| Package                                                   | Description                                                                          |
| --------------------------------------------------------- | ------------------------------------------------------------------------------------ |
| [`b2c-cli`](./packages/b2c-cli/README.md)                 | Command line interface built with oclif                                              |
| [`b2c-tooling-sdk`](./packages/b2c-tooling-sdk/README.md) | SDK/library for B2C Commerce operations; supports the CLI and can be used standalone |
| [`b2c-dx-mcp`](./packages/b2c-dx-mcp/README.md)           | MCP server for B2C Commerce developer experience tools                               |

## Development

### Prerequisites

- Node.js >= 22.16.0
- pnpm 10.17.1+

### Setup

```bash
pnpm install
```

### Running the CLI in Development Mode

```bash
pnpm start
# or directly:
pnpm --filter @salesforce/b2c-cli run dev
# or using convenience script:
./cli
```

The dev mode uses Node.js `--conditions=development` to resolve TypeScript source files directly from `@salesforce/b2c-tooling-sdk` without needing to build first.

### Building

```bash
# Build all packages
pnpm -r run build

# Build individual packages
pnpm --filter @salesforce/b2c-cli run build
pnpm --filter @salesforce/b2c-tooling-sdk run build
```

### Testing

Tests use [Mocha](https://mochajs.org/) + [Chai](https://www.chaijs.com/) with [c8](https://github.com/bcoe/c8) for coverage. HTTP mocking uses [MSW](https://mswjs.io/).

```bash
# Run all tests with coverage (also runs linter after tests)
pnpm test

# Run tests for a specific package
pnpm --filter @salesforce/b2c-tooling-sdk run test

# Run tests without coverage (faster)
pnpm --filter @salesforce/b2c-tooling-sdk run test:unit

# Watch mode for TDD
pnpm --filter @salesforce/b2c-tooling-sdk run test:watch

# Run a specific test file
cd packages/b2c-tooling-sdk
pnpm mocha "test/clients/webdav.test.ts"

# Run tests matching a pattern
pnpm mocha --grep "uploads a file" "test/**/*.test.ts"
```

#### Coverage

Coverage reports are generated in each package's `coverage/` directory:

- `coverage/index.html` - HTML report
- `coverage/lcov.info` - LCOV format for CI integration

The SDK package has a 5% coverage threshold that will fail the build if not met.

### Linting

```bash
# Run linter only
pnpm --filter @salesforce/b2c-cli run lint
pnpm --filter @salesforce/b2c-tooling-sdk run lint
```

### Code Formatting

This project uses Prettier for code formatting.

```bash
# Format all packages
pnpm -r run format

# Check formatting without modifying files
pnpm -r run format:check
```

## Documentation

Documentation is built using [TypeDoc](https://typedoc.org/) for API reference generation and [VitePress](https://vitepress.dev/) for the documentation site.

### Structure

- `docs/` - VitePress documentation source
  - `guide/` - User guide and getting started
  - `cli/` - CLI command reference
  - `api/` - Generated API documentation (do not edit manually)
- `typedoc.json` - TypeDoc configuration with entry points for SDK modules

### Development Server

```bash
pnpm run docs:dev
```

This runs `typedoc` to generate API docs, then starts VitePress in development mode with hot reload.

### Building Documentation

```bash
pnpm run docs:build
```

### Previewing Built Documentation

```bash
pnpm run docs:preview
```

### Deployed Documentation

The documentation site serves two versions:
- **Stable** (root URL) — built from the most recent release tag, updated on every stable release
- **Dev** (`/dev/`) — built from the `main` branch, updated on every push to `main`

Doc-only releases (without bumping CLI/SDK/MCP versions) are possible by creating a changeset targeting `@salesforce/b2c-dx-docs`. See [PUBLISHING.md](./PUBLISHING.md#documentation-deployment) for details.

### API Documentation

API documentation is auto-generated from JSDoc comments in the `@salesforce/b2c-tooling-sdk` package. The entry points are defined in `typedoc.json`:

See the [documentation site](https://salesforcecommercecloud.github.io/b2c-developer-tooling/) for the generated API reference.

- `auth` - Authentication strategies (OAuth, API Key, Basic)
- `instance` - B2C instance configuration
- `platform` - MRT and ODS clients
- `operations/code` - Cartridge code operations
- `operations/jobs` - Job execution
- `operations/sites` - Site management
- `i18n` - Internationalization utilities
- `logging` - Structured logging

When adding new public APIs, ensure they have comprehensive JSDoc comments as these will appear in the generated documentation.

### Bundled Platform Data (Script API docs, schemas, job steps)

The SDK ships several corpora derived from the B2C Commerce platform under `packages/b2c-tooling-sdk/data/`:

| Directory | Contents | Consumed by |
|-----------|----------|-------------|
| `script-api/` | Script API reference markdown + search index | `b2c docs search` / `docs read`, MCP `docs_*` |
| `content-schemas/` | Page Designer / content metadefinition JSON schemas | `b2c content validate` |
| `xsd/` | Import/export XSD schemas + search index | `b2c docs schema *`, XML validation |
| `job-steps/` | Standard job-step markdown + dataset + search index | `b2c docs search` / `docs read` |

All of these originate from the same documentation archive that `b2c docs download` fetches from an instance (the inner `DWAPP-<version>-API-doc.zip`). To refresh **all** of them to a new platform release at once, run the maintainer script against a current instance (it uses your default instance/auth via the CLI):

```bash
# Refresh every data set and regenerate the derived indexes
pnpm --filter @salesforce/b2c-tooling-sdk run refresh:docs-data

# Target a non-default instance, or keep the temp workdir for inspection
B2C_INSTANCE=my-sandbox KEEP_WORKDIR=1 pnpm --filter @salesforce/b2c-tooling-sdk run refresh:docs-data
```

The script prints the detected platform version (e.g. `DWAPP 26.7`). Afterward, review the diff under `packages/b2c-tooling-sdk/data/` (index files always change their `generatedAt` timestamp; look for substantive schema/doc changes), run `pnpm --filter @salesforce/b2c-tooling-sdk run test:agent`, and add a changeset if the refresh changes user-facing behavior. See the `sdk-module-development` skill for details.

## Releases and Publishing

This project uses [Changesets](https://github.com/changesets/changesets) for version management and publishes to npm using [OIDC trusted publishers](https://docs.npmjs.com/trusted-publishers).

| Release Type | npm Tag | Trigger |
|-------------|---------|---------|
| **Stable** | `@latest` | Merge version PR on `main` |
| **Release Branch** | `@latest` or `@release-X.Y` | Push to `release/**` branch |
| **Nightly** | `@nightly` | Scheduled (weekdays) or manual |

For detailed information about the release process, including release branches, see [PUBLISHING.md](./PUBLISHING.md).

### Quick Reference

```bash
# Create a changeset for your changes
pnpm changeset

# Check pending changesets
pnpm changeset status
```

### Preview Releases

Preview releases are available as tgz files on [GitHub Releases](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/releases) for testing before npm publication.

## Package Exports

The `@salesforce/b2c-tooling-sdk` package uses the `exports` field in package.json to define its public API surface. Each module is available as a subpath export:

```typescript
import {OAuthStrategy} from '@salesforce/b2c-tooling-sdk/auth';
import {B2CInstance} from '@salesforce/b2c-tooling-sdk/instance';
import {getLogger} from '@salesforce/b2c-tooling-sdk/logging';
```

The `development` condition in exports enables direct TypeScript source resolution when using `--conditions=development`, which is how `bin/dev.js` works for local development.

## Contributing

We welcome contributions! Please see our [Contributing Guide](./CONTRIBUTING.md) for details on how to get started, submit pull requests, and our code of conduct.

### Third-Party Dependency Review

To prevent net-new third-party libraries from being added without discussion, PRs are checked by the `3PL Guard` workflow (`Net-new 3PL check`).

- The check compares changed `package.json` files in the PR and detects net-new external dependencies.
- If net-new dependencies are found, the PR is labeled `needs-3pl-review` and the check fails.
- After discussion and approval, a maintainer adds the `3pl-approved` label to allow the check to pass.
- If the net-new dependency is removed, `needs-3pl-review` is removed automatically.

To enforce this as a merge gate, keep `Net-new 3PL check` as a required status check in branch protection.

## Security

For security concerns, please review our [Security Policy](./SECURITY.md). Report any security issues to [security@salesforce.com](mailto:security@salesforce.com).

## License

This project is licensed under the Apache License 2.0. See [LICENSE.txt](./LICENSE.txt) for full details.

## Disclaimer

This project is provided "as-is" without warranty of any kind. While the CLI, SDK, and MCP server are **Generally Available**, the VS Code extension is currently in **Developer Preview** — see its [documentation](./docs/vscode-extension/index.md) for details. Breaking changes to any component will follow a documented deprecation cycle.

b2c-developer-tooling

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README