You are here:
Helpful Commands
Here’s a quick reference list of the Visual Studio (VS) Code Based Modeler CLI commands.
Required Editions
| Available in: Enterprise and Unlimited Editions that have Consumer Goods Cloud enabled |
To view the complete list of VS Code Based Modeler CLI commands, run sf modeler
workspace --help.
This table lists the commonly used VS Code Based Modeler CLI commands and other useful commands:
| Command | Alias/Short Command | Description |
|---|---|---|
sf modeler workspace create
|
— | Creates a Modeler workspace. |
sf modeler workspace upgrade
|
— | Updates your installed version of the Modeler CLI plugin with the latest version of the plugin. |
sf modeler workspace server start
|
|
Starts the server to simulate the application. |
sf modeler workspace add
|
|
Adds resources to local workspace by using existing snippets. Default parameters are type, name, and module. |
sf modeler workspace build
|
|
Builds a workspace. |
sf modeler workspace package
|
|
Creates a deployment package of a workspace. The deployment package is found in $workspace/appl/build |
sf modeler workspace cleanup
|
|
Cleans a workspace. |
sf modeler workspace refreshLocale
|
— | Refreshes locale translation in a workspace. |
sf modeler workspace utils importContracts -i <value> [—json] [-p
<value>] [-c]
|
— | Transforms and imports contracts from Modeler Contract Package (MCP) to a VS Code based Modeler workspace. See Import Contracts to Modeler Workspace. |
sf modeler workspace utils base64encode
|
— | Generates the encoded Base-64 string of PNG or SVG image files. |
sf modeler workspace utils migrateContracts
|
— | Migrates the Modeler workspace. The migration process transforms business logic
XML contracts to JavaScript files (bl.js), validates pagePattern,
bindingMode, and actionType attribute values in
process and UI contracts, and removes XML namespace specifications present in
contracts from Windows Server based Modeler contracts. |
sf modeler workspace validate
|
|
Validates the contracts in a workspace. |
sf plugins uninstall <plugin_name>
|
— | Uninstalls the specified Salesforce plugin. |
sf plugins
|
— | Lists all plugins currently installed on your system. |
sf plugins update
|
— | Updates the plugins currently installed on your system. |
Did this article solve your issue?
Let us know so we can improve!

