bldr logo
Get Started

Getting Started

Install BLDR CLI

  • Open the terminal and check if you have the following:
    • Ensure you have Node.js installed by typing node --version
      • If you do not have Node.js installed visit nodejs.org and follow the instructions for installation
    • (optional) Ensure you have GIT installed by typing git version
      • If you do not have GIT installed go to git-scm.com/downloads and follow the instructions for installation
    • In your terminal run npm install -g @basetime/bldr-sfmc
      • NOTE: You must include the -g flag to be able to use this across multiple projects

Updating BLDR CLI

Open your terminal and run npm update -g @basetime/bldr-sfmc


Prepair for Configuration

The BLDR CLI is designed so you can use it across as many SFMC instances as you require. The interactions with SFMC are completed using a Server-to-Server API Package set up within each SFMC Instance.

In team secnarios, it's recommended that a shared Installed Package be created for the CLI that can be used between all team members.


SFMC Installed Package

  1. Navigate to Settings > Setup > Platform Tools > Apps > Installed Packages
  2. Click on New to create a new Package and name it bldr-cli
  3. Click on Add Component to add a new API Component and select API Integration and then Server-to-Server
  4. Navigate to Access and ensure that the Installed Package is provisioned for all Business Units that you may need access to
  5. Update the scope of the Installed Package to match the permissions below

ScopeAccess
EmailRead, Write
WebRead, Write
Documents and ImagesRead, Write
Saved ContentRead, Write
AutomationsRead, Write
JourneysRead, Write
List and SubscribersRead
Data ExtensionsRead, Write
File LocationsRead, Write
AccountsRead



Troubleshooting installation

Permission Issues

If you run into permissions issues while installing bldr, you can run the install command as sudo npm install -g @basetime/bldr-sfmc.

Libsecret Issue

BLDRs enhanced secrity to handle the storing of your API Credentials is handled through the keytar library. As such, the keytar library uses a library called libsecret to access the systems credential manager. Libsecret cannot be included as a dependency so you may need to install it prior to installing BLDR. Follow the instructions on the keytar npm page or try the below instructions to install the libsecret library.

MacOs

  1. Install Homebrew
  2. Install Libsecret

Config