sfcc (Salesforce Commerce Cloud)

This tool has not been maintained since 2017, as I no longer work for an employer that uses Salesforce Commerce Cloud.

Thank you to those who have been using it!

This is a command line tool to ease development on Salesforce Commerce Cloud (Demandware before its acquisition), an e-commerce framework. It's a work-in-progress, and currently supports:

• importing your cartridges from an instance
• watching and syncing local changes to a sandbox instance
• deploying your cartridges to a specified code version

You can use ES6 syntax, such as arrow functions, as your code will be transpiled to ES5 by Babel. You can also change SASS files, as this tool will compile them using node-sass and then sync the resulting CSS files.

Setup

npm install sfcc -g

Create a .env file in the root directory of your project, containing the following variables:

SFCC_DOMAIN=sandbox-web-customer.demandware.net
SFCC_USERNAME=username
SFCC_PASSWORD=password

The username and password of a business manager account with the Administrator role (with WebDAV permissions) needs to be used.

For staging

If you are deploying to staging rather than a sandbox instance, you also need to generate a .p12 file. This is outlined in the "Using Two-Factor Authentication for Code Deployment" section in the Salesforce Commerce Cloud documentation. Place the .p12 file in the root directory, and add the following variables:

SFCC_CERTIFICATE=certificate.p12
SFCC_CERTIFICATE_PASSPHRASE=passphrase

Don't forget to update SFCC_DOMAIN as well, which should be a URL of the form cert.staging.web.customer.demandware.net.

SFCC_CERTIFICATE_PASSPHRASE is optional and can be left out.

Commands

• sfcc import [codeVersion]
• sfcc watch [codeVersion]
• sfcc deploy [codeVersion]

Omitting codeVersion will prompt you to select from code versions on the server.

Issues

If you are starting out with the SiteGenesis codebase, you may need to prepend a _ to the filename of all .scss files inside scss/default/lib/flag-icon-css.