Set Up Your Project

From a fresh install to the first uploaded change. Install the plugin first, see Installation

Have these ready

• The project with your cartridge sources, opened at its root
• The instance hostname, for example dev01-realm-customer.demandware.net
• A Business Manager account for that instance, or your team's encrypted credentials file and its secret key
• The code version you develop against. You can also create one from the IDE

Open your project

Open the project root, the folder that holds your cartridges

Welcome screenTrust the projectFile menu

IntelliJ IDEAFile

New

Open…

Open Recent

Close Project

Rename Project…

Project Structure…⌘;

File Properties

Local History

Save All⌘S

Reload All from Disk⌥⌘Y

EditViewWindowHelpMon 12 Oct 09:14

STstorefront

Project

storefront~/projects/storefrontcartridgesapp_customapp_storefront_baseint_paymentpackage.jsonExternal Libraries

Search Everywhere Double ⇧Go to File ⇧⌘ORecent Files ⌘ENavigation Bar ⌘↑Drop files here to open them

storefrontLFUTF-8

Indexing…

Welcome to IntelliJ IDEA

IJIntelliJ IDEA2026.3

ProjectsRemote DevelopmentCustomizePluginsLearn

Search projectsNew ProjectOpenClone Repository

OUoutlet~/projects/outlet

projectsSearch

FavouritesRecentsDesktopDocumentsprojects

NameDate Modified

outletYesterday, 18:20

storefrontToday, 09:14

storefront-docs3 Oct 2026

notes.txt28 Sep 2026

CancelOpen

Trust and Open Project 'storefront'?

IntelliJ IDEA provides features that may automatically execute code contained in this project.

If you don't trust the source, preview the project in safe mode.

Trust projects in ~/projects

Don't OpenPreview in Safe ModeTrust Project

Select the project root and click Open. On the Trust and Open Project prompt click Trust Project, then let indexing finish. Until a cartridge is linked, the plugin shows only Find New Cartridges and More in the main toolbar

Use Getting Started

Intellij SFCC: Getting Started walks a project through setup in an editor tab: seven setup steps, then a short tour of the main toolbar, the tool windows, B2C Explorer, the Project view menu and B2C Entry Points. Five steps are tracked: Activate, Add credentials, Add a connection, Link cartridges and Select site scope. Upload and deploy and the B2C project view come last and are not counted

Open the guideCredentialsConnectionCartridgesSite scopeAuto Upload

STstorefrontSandbox 01version2

Intellij SFCC: Getting Started

Search Everywhere Double ⇧Go to File ⇧⌘ORecent Files ⌘ENavigation Bar ⌘↑Drop files here to open them

Seven setup steps, then a short tour. Every button runs the real action in your IDE

Don't open automaticallyOpens on startup until a project's setup is doneShow only the panda in the status bar

Set up

ActivateAdd credentialsAdd a connectionLink cartridgesSelect site scopeUpload and deployB2C project view

5 of 5 done

Learn the plugin

8Main toolbar9Tool windows10B2C Explorer11Project view menu12B2C Entry PointsRead the docs

Upload and deployBackNextB2C project view

Turn on Auto Upload and every file you save in a linked cartridge goes to the active code version. Deploy Code zips your cartridges and deploys them to one instance or several

Auto Upload is on for Sandbox 01

Deploy codeOpen B2C Sync LogTurn off Auto Upload

New Account

Username:Password:

CancelAdd

Sandbox 01

ConnectionsSandbox 01

All changes are automatically savedName:Sandbox 01Hostname:zzrx-001.dx.commercecloud.salesforce.comAccount:[email protected]Code Version:version2Test ConnectionActive: version2

Close

Found 3 cartridges

To start working with cartridges, link them to the project. Otherwise, they will be ignored (no auto upload, debugging etc.)

Link to projectIgnoreCartridgePath

app_custom/Users/you/storefront/cartridges/app_custom

app_storefront_base/Users/you/storefront/cartridges/app_storefront_base

int_payment/Users/you/storefront/cartridges/int_payment

CancelOK

B2C Site Scopes

Remote instance: Sandbox 01

RefArch

RefArchGlobal

Local project

RefArch

Global

Global scope

storefrontRefArch (3)SetupLFUTF-8

Open the Intellij SFCC Getting Started guide⌘VPasteWindows and Linux Ctrl+V

After indexing, the tab opens by itself in the first project you open after installing the plugin, SFCC or not. From then on it opens every time you open an SFCC project whose setup is unfinished: linked cartridges, cartridges on disk not linked yet, a dw.json that names a host, or a connection. The page ships with the plugin, so it works offline and matches the plugin version. Its docs and pricing links open in your browser

Every step has a button that runs the real action in the IDE:

• Activate plugin opens the IDE's license dialog, where you start the 7-day trial or activate a license. Check activation checks again
• Add account opens New Account
• Add connection opens the connections editor on a new connection
• Find new cartridges lists the cartridges and modules in the project that are not linked yet
• Select site scope opens B2C Site Scopes
• Turn on Auto Upload turns it on for the active connection, so check the connection and code version in the main toolbar first
• Show B2C project view opens the Project tool window on the Salesforce B2C Commerce view

The first time it opens by itself, a tooltip points at the Setup item in the status bar, or a notification names the Help menu in a project without SFCC code. To come back to it later, use any of these routes. The tab opens on the first unfinished step

Route	What to do
Status bar	Click Setup 2/5 at the right end of the status bar. Once all five main steps are done it reads Setup
Help menu	Help › Intellij SFCC Getting Started
Main toolbar	More › Getting Started
Find Action	⇧⌘A (Ctrl+Shift+A), type Getting Started and choose Intellij SFCC Getting Started

Tick Don't open automatically on the page to open it only from these routes, in every project in this IDE. Tick Show only the panda in the status bar to drop the item's text. Its tooltip still shows the progress

If the IDE runs without its built-in browser (JCEF), Getting Started never opens by itself and the routes above open this page instead. Follow the steps below

Projects without SFCC code

In a project with no cartridges, no dw.json and no connection, the plugin stays out of the way: no Setup item, no SFCC tool windows, and Getting Started does not open. Cartridges in test or fixture folders do not count. When Find New Cartridges finds nothing, it offers Create Cartridge… and Set Up Anyway, which shows the setup in that project from then on. Opening a tool window from More does the same

B2C Explorer, B2C Credentials, B2C ODS and B2C OCAPI appear with SFCC code. B2C Entry Points, B2C Metadata, B2C Sync Log and the Site Scope item appear once a cartridge is linked. Cartridges cloned or copied in while the project is open show them without a restart, and nothing hides again until the next start

Connect your project

Link your cartridges

A few seconds after the project opens, a notification lists the cartridges and modules found. Click Review…, uncheck what you don't work on or click Ignore on a row to stop suggesting it, then click Link. Link All links everything in one click when no name is taken. If no notification appears, click Find New Cartridges in the main toolbar, or ⇧⌘A (Ctrl+Shift+A) › Find New Cartridges

NotificationReviewIgnoreLink

STstorefront

Project

storefront~/storefrontcartridgesappapp_customapp_storefront_basebm_customint_paymentmodulesplugin_wishlistsvendorplugin_giftregistrycartridgesplugin_giftregistrypackage.json

package.json

1{

2 "name": "storefront",

3 "version": "1.0.0",

4 "scripts": {

5 "compile:js": "sgmf-scripts --compile js",

6 "lint": "eslint cartridges"

7 }

8}

8 new cartridges and modules foundapp_custom, app_storefront_base, bm_custom and 5 more are not linked to the project yetReview…Link AllDon't Ask Again

Link Cartridges and Modules to storefront

8 cartridges and modules are not linked yetChecked folders are linked to the project. Unchecked ones come back with the next scan, ignored ones don't.

All7 of 7 to link·1 to ignoreFilter by name or folder

cartridges7

appB2C module

app_custom

app_storefront_base

bm_custom

int_payment

modulesGlobal modules

plugin_wishlists

vendor/plugin_giftregistry/cartridges1

plugin_giftregistryIgnoredIgnore (Delete)

Look for new cartridges and modules when the project opensCancelLink 7 Cartridges and Modules

storefrontLFUTF-8

Find New Cartridges

Most plugin actions stay hidden until at least one cartridge is linked, see Cartridges & Modules

Add your account

Open B2C Credentials on the right tool window bar (or View › Tool Windows › B2C Credentials). On the Accounts tab click +, enter the Username in the same text case as on the instance and the Password, and click Add

Tool window barFind ActionAdd the account

STstorefrontAdd Connection

Cart.js

1'use strict';

2

3var server = require('server');

4server.extend(module.superModule);

5

6server.append('Show', function (req, res, next) {

7 next();

8});

B2C CredentialsAccountsOCAPISettings

AccountNothing to show

New Account

Username:[email protected]Password:••••••••••••

CancelAdd

storefrontapp_customcartridgecontrollersCart.jsLFUTF-8

AllClassesFilesSymbolsActions

⇧⌘AFind ActionWindows and Linux Ctrl+Shift+A

If your team shares an encrypted credentials file, link it on the Settings tab instead, see Sync credentials to a file

Add the connection

In B2C Explorer on the right tool window bar, click + › Add Connection. While there are no connections, Select Connection in the main toolbar reads Add Connection and opens the same editor

Open B2C ExplorerAdd a connectionFill in the instanceTest the connectionClose

STstorefrontSandbox 02version1

Project⌘1Commit⌘0Structure⌘7Terminal⌥F12Problems⌘6Git⌘9B2C Sync LogB2C ODS

Cart.js

1'use strict';

2

3var server = require('server');

4server.extend(module.superModule);

5

6server.append('Show', function (req, res, next) {

7 next();

8});

B2C Explorer

Sandbox 01zzrx-001.dx.commercecloud.salesforce.comSandbox 02zzrx-002.dx.commercecloud.salesforce.comCode versionsLog FilesSecurity Log FilesIMPEXTempRealm DataOrganization Static ContentCatalogsContent Images (Library)Velocity Templates

Add Connection

Add Group

NotificationsB2C ExplorerB2C CredentialsB2C Entry PointsB2C MetadataB2C OCAPI

Sandbox 01

Connections

Sandbox 01zzrx-001.dx.commercecloud.salesforce.comSandbox 02zzrx-002.dx.commercecloud.salesforce.com

All changes are automatically savedName:Sandbox 01Hostname:zzrx-001.dx.commercecloud.salesforce.comCopy full url from your browser and paste here. URL will be formatted automatically.Account:[email protected]NOTE: Your account must be in the same text case as in the B2C Commerce instanceUse lowercase username on authentication requests When to use it?Code Version:version2Test ConnectionActive: version2Connected to zzrx-001.dx.commercecloud.salesforce.comNow you can select code version

OCAPICertificate Settings

Use OCAPIObtain a Business Manager user grantCredentials:Version:

Close

storefrontRefArch (3)LFUTF-8

⌘VPasteWindows and Linux Ctrl+V

Enter a Name, paste the Business Manager URL from your browser into Hostname (it is cut down to the host) and choose the Account. Click Test Connection, pick your Code Version or create one with Add Code Version, then click Close, see Connections

Make it active

Click Select Connection in the main toolbar and choose the connection, the target of uploads, deploys and the debugger. Then pick your code version in Select Code Version next to it

Check the remote side

In B2C Explorer expand Code versions under the connection, then your version. Your cartridges are listed there once they have been uploaded

Select connectionCode versionBrowse remote

STstorefrontSandbox 01version2

B2C Explorer

Sandbox 01zzrx-001.dx.commercecloud.salesforce.com

Code versions(2)

version1- [Active on instance]5 days agoversion2(3)2 hours ago

app_custom2 hours agoapp_storefront_base2 hours agoint_payment2 hours ago

Log FilesSecurity Log FilesIMPEXTempRealm DataOrganization Static ContentCatalogsContent Images (Library)Velocity Templates

Sandbox 02zzrx-002.dx.commercecloud.salesforce.com

Cart.js

1'use strict';

2

3var server = require('server');

4server.extend(module.superModule);

5

6server.append('Show', function (req, res, next) {

7 next();

8});

9

10module.exports = server.exports();

Add Connection

Sandbox 01

Sandbox 02

Add Code Version

version1 - [Active on instance]

version2

storefrontapp_customcartridgecontrollersCart.jsRefArch (3)LFUTF-8

Send your first change

If setup fails

Pipeline Editor performance

If scrolling or zooming in the Pipeline Editor lags, add -Djcef.remote.enabled=false to the IDE's custom VM options and restart the IDE

From the editorHelp menuAdd the optionRestart

IntelliJ IDEAFileEditViewNavigateCodeRefactorBuildRunToolsGitWindowHelpFri 23 Oct 10:42

STstorefrontSandbox 01version2

Project⌘1Commit⌘0Structure⌘7Terminal⌥F12Problems⌘6Git⌘9B2C Sync LogB2C ODS

Cart Pipeline EditorCart.xmlidea.vmoptions

Pipeline editor may feel slow. Restart with the faster rendering setting for smoother scrolling, zoom, and editing.Apply for Next RestartOpen VM OptionsRead DocsDo not show again

No changes

Search nodes or breakpoints

Pinch to zoom⌘+Scroll to zoomShift+Drag to select an area⌘+Click to add or removeDeleteDelete the selection⌘SSaveF5Start Debugging

1# custom IntelliJ IDEA VM options (expand/override 'bin/idea.vmoptions')

2

3-Xmx4096m

4-Djcef.remote.enabled=false

NotificationsB2C ExplorerB2C CredentialsB2C Entry PointsB2C MetadataB2C OCAPI

UsersyouLibraryApplication SupportJetBrainsIntelliJIdea2026.3idea.vmoptionsRefArch (3)LFUTF-8

Confirm Exit

Are you sure you want to exit?

CancelExit

Search

Find Action…⇧⌘A

Help

Getting Started

Keyboard Shortcuts PDF

Contact Support…

Submit a Bug Report…

Submit Feedback…

Show Log in Finder

Collect Logs and Diagnostic Data

Diagnostic Tools

Change Memory Settings

Edit Custom Properties…

Edit Custom VM Options…

Delete Leftover IDE Directories…

About IntelliJ IDEA

Check for Updates…

Settings…⌘,

Services

Hide IntelliJ IDEA⌘H

Hide Others⌥⌘H

Show All

Quit IntelliJ IDEA⌘Q

⌘SSave AllWindows and Linux Ctrl+S

Put the option on its own line and keep the lines already in the file. Save, quit the IDE (⌘Q on macOS, File › Exit on Windows and Linux) and start it again. Closing the project or the tab is not enough

The option affects every embedded browser in the IDE, see Performance for the full guide and how to undo it

Where to go next