Skip to content

Latest commit

 

History

History
521 lines (362 loc) · 17.4 KB

File metadata and controls

521 lines (362 loc) · 17.4 KB
description Commands for viewing configuration, managing instances, installing AI agent skills, and generating IDE integration scripts.

Setup Commands

Commands for viewing configuration, setting up the development environment, and generating IDE integration scripts.

b2c setup inspect

Display the resolved configuration from all sources, showing which values are set and where they came from. Useful for debugging configuration issues.

Alias: b2c setup config

Usage

b2c setup inspect [FLAGS]

Flags

Flag Description Default
--unmask Show sensitive values unmasked (passwords, secrets, API keys) false
--json Output results as JSON false

Examples

# Display resolved configuration (sensitive values masked)
b2c setup inspect

# Display configuration with sensitive values unmasked
b2c setup inspect --unmask

# Output as JSON for scripting
b2c setup inspect --json

# Debug configuration with a specific instance
b2c setup inspect -i staging

Output

The command displays configuration organized by category:

  • Instance: hostname, webdavHostname, codeVersion
  • Authentication (Basic): username, password
  • Authentication (OAuth): clientId, clientSecret, scopes, authMethods, accountManagerHost
  • SCAPI: shortCode
  • Managed Runtime (MRT): mrtProject, mrtEnvironment, mrtApiKey, mrtOrigin
  • Metadata: instanceName
  • Sources: List of configuration sources that contributed values

Each value shows its source in brackets (e.g., [dw.json], [SFCC_CLIENT_ID], [~/.mobify]).

Example output:

Configuration
────────────────────────────────────────────────────────────

Instance
  hostname              my-sandbox.dx.commercecloud.salesforce.com  [DwJsonSource]
  webdavHostname        -
  codeVersion           version1                                     [DwJsonSource]

Authentication (Basic)
  username              admin                                        [DwJsonSource]
  password              admi...REDACTED                              [DwJsonSource]

Authentication (OAuth)
  clientId              my-client-id                                 [password-store]
  clientSecret          my-c...REDACTED                              [password-store]
  scopes                -
  authMethods           -
  accountManagerHost    -

SCAPI
  shortCode             abc123                                       [DwJsonSource]

Managed Runtime (MRT)
  mrtProject            my-project                                   [MobifySource]
  mrtApiKey             mrtk...REDACTED                              [MobifySource]

Sources
────────────────────────────────────────────────────────────
  1. DwJsonSource         /path/to/project/dw.json
  2. MobifySource         /Users/user/.mobify
  3. password-store       pass:b2c-cli/_default

Sensitive Values

By default, sensitive fields are masked to prevent accidental exposure:

  • password - Basic auth access key
  • clientSecret - OAuth client secret
  • mrtApiKey - MRT API key

Use --unmask to reveal the actual values when needed for debugging.

See Also

b2c setup ide

Show help for IDE integration setup commands.

Usage

b2c setup ide

Examples

# Show setup ide subcommands
b2c setup ide --help

# Generate Prophet integration script
b2c setup ide prophet

b2c setup ide prophet

Generate a dw.js script for the Prophet VS Code extension.

The script runs b2c setup inspect --json --unmask at runtime and maps the resolved configuration into a dw.json-compatible structure that Prophet can consume.

Usage

b2c setup ide prophet [FLAGS]

Flags

Flag Description Default
--output, -o Path for generated script file dw.js
--force, -f Overwrite output file if it already exists false
--json Output results as JSON false

Examples

# Generate ./dw.js
b2c setup ide prophet

# Overwrite existing dw.js
b2c setup ide prophet --force

# Generate into .vscode folder
b2c setup ide prophet --output .vscode/dw.js

# Pin generated script to a specific instance context
b2c setup ide prophet --instance staging

Output

The command creates a JavaScript file that:

  1. Executes setup inspect --json --unmask
  2. Reads resolved config values (including plugin-provided sources)
  3. Falls back to loading dw.json from SFCC_CONFIG or the dw.js directory if inspect cannot run
  4. Exports the final object via module.exports = dwJson
  5. Emits Prophet-compatible keys such as:
    • hostname, username, password
    • code-version
    • cartridgesPath, siteID, storefrontPassword (when present)
  6. Logs diagnostics to both stdout and stderr when resolution fails

b2c setup instance list

List all configured B2C Commerce instances from dw.json.

Usage

b2c setup instance list [FLAGS]

Flags

Flag Description Default
--json Output results as JSON false

Examples

# List all configured instances
b2c setup instance list

# Output as JSON
b2c setup instance list --json

Output

The command displays a table of configured instances:

Instances
────────────────────────────────────────────────────────────
Name           Hostname                          Source        Active
production     prod.demandware.net               DwJsonSource
staging        staging.demandware.net            DwJsonSource  ✓
development    dev.demandware.net                DwJsonSource

b2c setup instance create

Create a new B2C Commerce instance configuration in dw.json.

Usage

b2c setup instance create [NAME] [FLAGS]

Arguments

Argument Description Required
NAME Instance name Yes (or prompted)

Flags

Flag Description Default
--hostname, -s B2C instance hostname Prompted
--username WebDAV username
--password WebDAV password Prompted if username set
--client-id OAuth client ID
--client-secret OAuth client secret Prompted if client-id set
--code-version Code version
--active Set as active instance false
--force Non-interactive mode false
--json Output results as JSON false

Examples

# Interactive mode (prompts for all values)
b2c setup instance create staging

# Create with hostname
b2c setup instance create staging --hostname staging.example.com

# Create and set as active
b2c setup instance create staging --hostname staging.example.com --active

# Non-interactive mode (CI/CD)
b2c setup instance create staging --hostname staging.example.com --username admin --password secret --force

Interactive Mode

When run without --force, the command provides an interactive experience:

  1. Prompts for instance name (if not provided)
  2. Prompts for hostname (if not provided)
  3. Prompts for authentication type (Basic, OAuth, Both, or Skip)
  4. Prompts for credentials based on selection
  5. Asks whether to set as active instance
  6. Shows summary and confirms before creating

b2c setup instance remove

Remove a B2C Commerce instance configuration from dw.json.

Usage

b2c setup instance remove NAME [FLAGS]

Arguments

Argument Description Required
NAME Instance name to remove Yes

Flags

Flag Description Default
--force Skip confirmation prompt false
--json Output results as JSON false

Examples

# Remove with confirmation
b2c setup instance remove staging

# Remove without confirmation
b2c setup instance remove staging --force

b2c setup instance set-active

Set a B2C Commerce instance as the default (active) instance.

Usage

b2c setup instance set-active NAME [FLAGS]

Arguments

Argument Description Required
NAME Instance name to set as active Yes

Flags

Flag Description Default
--json Output results as JSON false

Examples

# Set staging as the active instance
b2c setup instance set-active staging

# Set production as active
b2c setup instance set-active production

How Active Instance Works

The active instance is used as the default when no --instance or -i flag is provided to other commands. This allows you to work with multiple instances without specifying which one to use each time.

Example workflow:

# Configure multiple instances
b2c setup instance create staging --hostname staging.example.com
b2c setup instance create production --hostname prod.example.com

# Set staging as active
b2c setup instance set-active staging

# Commands now use staging by default
b2c code list              # Uses staging
b2c code list -i production # Uses production

b2c setup skills

Install agent skills from the B2C Developer Tooling project to AI-powered IDEs.

This command downloads skills from GitHub releases and installs them to the configuration directories of supported IDEs. Skills teach AI assistants about B2C Commerce development, CLI commands, and best practices.

Usage

b2c setup skills [SKILLSET]

Arguments

Argument Description Default
SKILLSET Skill set to install: b2c or b2c-cli Prompted interactively

Flags

Flag Description Default
--list, -l List available skills without installing false
--skill Install specific skill(s) (can be repeated)
--ide Target IDE(s): claude-code, cursor, windsurf, vscode, codex, opencode, agentforce-vibes, manual Auto-detect
--directory, -d Custom installation directory (overrides IDE default path)
--global, -g Install to user home directory (global scope) false
--update, -u Update existing skills (overwrite) false
--version Specific release version latest
--force Skip confirmation prompts (non-interactive) false
--json Output results as JSON false

Supported IDEs

IDE Value IDE Name Project Path Global Path
claude-code Claude Code .claude/skills/ ~/.claude/skills/
cursor Cursor .cursor/skills/ ~/.cursor/skills/
windsurf Windsurf .windsurf/skills/ ~/.codeium/windsurf/skills/
vscode VS Code / GitHub Copilot .github/skills/ ~/.copilot/skills/
codex OpenAI Codex CLI .codex/skills/ ~/.codex/skills/
opencode OpenCode .opencode/skills/ ~/.config/opencode/skills/
agentforce-vibes Agentforce Vibes .a4drules/skills/ ~/Library/Application Support/Code/User/globalStorage (macOS)
manual Manual .agents/skills/ ~/.agents/skills/

Use agentforce-vibes for Salesforce Agentforce for VS Code. Use manual for generic installation with a custom --directory path.

Examples

# Interactive mode (prompts for skillset and IDEs)
b2c setup skills

# List available skills in a skillset
b2c setup skills b2c --list
b2c setup skills b2c-cli --list

# Install b2c skills to Cursor (project scope)
b2c setup skills b2c --ide cursor

# Install b2c-cli skills to Cursor (global/user scope)
b2c setup skills b2c-cli --ide cursor --global

# Install to multiple IDEs
b2c setup skills b2c --ide cursor --ide windsurf

# Install specific skills only
b2c setup skills b2c-cli --skill b2c-code --skill b2c-webdav --ide cursor

# Install to Agentforce Vibes (.a4drules/skills/)
b2c setup skills b2c --ide agentforce-vibes

# Install to a custom directory
b2c setup skills b2c --ide manual --directory ./my-skills

# Update existing skills
b2c setup skills b2c --ide cursor --update

# Non-interactive mode (for CI/CD) - skillset required
b2c setup skills b2c-cli --ide cursor --global --force

# Install a specific version
b2c setup skills b2c --version v0.1.0 --ide cursor

# Output as JSON
b2c setup skills b2c --list --json

Interactive Mode

When run without --force, the command provides an interactive experience:

  1. Prompts you to select skill set(s) (if not provided as argument) - you can select both b2c and b2c-cli
  2. Downloads skills from the latest release (or specified version)
  3. Auto-detects installed IDEs
  4. Prompts you to select target IDEs
  5. Shows installation preview
  6. Confirms before installing
  7. Reports results

In non-interactive mode (--force), the skillset argument is required.

Claude Code Recommendation

For Claude Code users, we recommend using the plugin marketplace for automatic updates:

claude plugin marketplace add SalesforceCommerceCloud/b2c-developer-tooling
claude plugin install b2c-cli
claude plugin install b2c

The marketplace provides:

  • Automatic updates when new versions are released
  • Centralized plugin management
  • Version tracking

Use --ide manual if you prefer manual installation, or --ide agentforce-vibes to install to the .a4drules/skills/ directory used by Salesforce Agentforce for VS Code.

Skill Sets

Skill Set Description
b2c B2C Commerce development patterns and practices
b2c-cli B2C CLI commands and operations

Output

When installing, the command reports:

  • Successfully installed skills with paths
  • Skipped skills (already exist, use --update to overwrite)
  • Errors encountered during installation

Example output:

Downloading skills from release latest...
Detecting installed IDEs...
Installing 12 skills to Cursor (project)

Successfully installed 12 skill(s):
  - b2c-code → .cursor/skills/b2c-code/
  - b2c-webdav → .cursor/skills/b2c-webdav/
  ...

Environment

Skills are downloaded from the GitHub releases of the b2c-developer-tooling repository:

Artifact Contents
b2c-cli-skills.zip Skills for B2C CLI commands and operations
b2c-skills.zip Skills for B2C Commerce development patterns

Downloaded artifacts are cached locally at: ~/.cache/b2c-cli/skills/{version}/{skillset}/

See Also