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
- NOTE: You must include the
- Ensure you have Node.js installed by typing
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
- In SFMC, navigate to
Settings > Setup > Platform Tools > Apps > Installed Packages
- Click on
New
to create a new Package and name itbldr-cli
- Click on
Add Component
to add a new API Component and selectAPI Integration
and thenServer-to-Server
orWeb App
- For
Web App
configurations, includehttps://bldr.io/cli/sfmc/authenticate/
as the Redirect URI
- For
- Navigate to
Access
and ensure that the Installed Package is provisioned for all desired Business Units - Update the scope of the Installed Package to match the following:
Scope | Access |
---|---|
Read, Write | |
Web | Read, Write |
Documents and Images | Read, Write |
Saved Content | Read, Write |
Automations | Read, Write |
Journeys | Read, Write |
List and Subscribers | Read |
Data Extensions | Read, Write |
File Locations | Read, Write |
Accounts | Read |
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
Submitting an Issue
If issues persist:
- Turn on Debugging Mode
bldr config --debug
- Visit BLDR GitHub Issues
- Open an issues with the details and relavent dubugging output