Install and Update the Omnistudio Build Tool (Managed Package)

For the managed package runtime, install or update the Build Tool by installing Node.js or through the Node Package Manager (NPM). Downloads are available for each release.

Managed Package app icon This information is for Omnistudio for Managed Packages. For Omnistudio on standard runtime, see Omnistudio Help.

Install Node.js

Download and install Node.js.

The Build Tool requires Node.js version 10 or later.

To find your current version, use node -v.

Install or Update the Build Tool through NPM

Install or update the the Build Tool package like any other Node package.

npm install --global vlocity
vlocity help

This command outputs a list of all available commands, confirming that the project has been installed or updated.

Note Don’t clone the build repository directly. If you cloned the Build project and the alias vlocity is still used as the cloned project, use this command in the cloned vlocity_build folder to unlink it:

npm unlink .

To use the build project from its source, use this command in the cloned vlocity_build folder:

npm link
npm install

Releases

Find all releases for this project in the GitHub repository for Vlocity Build.

Each release includes a binary for the supported operating systems:

Linux
MacOS
Windows

To install an older version of the Build Tool, use this NPM command:

npm install --global vlocity@1.9.1
vlocity help