Skip to content
Jörn Berkefeld edited this page Apr 20, 2024 · 10 revisions

view on npm view on npm license npm module downloads GitHub closed issues GitHub releases

Accenture Salesforce Marketing Cloud DevTools (mcdev) is a rapid deployment/rollout, backup and development tool for Salesforce Marketing Cloud. It allows you to retrieve and deploy configuration and code across Business Units and instances.

Quick start

Install

Run the following to install Accenture SFMC DevTools on your computer:

npm install -g mcdev

A more detailed guide on installing mcdev is in the Getting Started section of this wiki.

VSCode Extension

We also provide a VSCode extension that integrates SFMC DevTools into your IDE. You can install it from the VSCode Marketplace.

Include in your package

First, install it as a dependency:

npm install mcdev --save

You can then include it in your code with JavaScript/ES module imports:

import mcdev from 'mcdev';

That will load node_packages/mcdev/lib/index.js. It can make sense to directly include other files if you have a special scenario. We've done that in our example for retrieveChangelog.js or in more detail, in our child-project sfmc-devtools-copado to get full control over certain aspects.

⚠️ Note: The CommonJS module format const mcdev = require('mcdev') is no longer supported starting with version 6.0.0 of mcdev!

If you want to hook into some of the internals, importing the type classes and there definitions might come in handy:

import mcdevDefinition from 'mcdev/lib/MetadataTypeDefinitions';
import mcdevType from 'mcdev/lib/MetadataTypeInfo';

const DataExtension = mcdevType.dataExtension;
const dataExtensionConfig = mcdevDefinition.dataExtension;

Internal type declarations are usable via this import:

import types from 'mcdev/types/mcdev.d';

Documentation

Please check out the navigation bar to the right of this text for the full documentation.

Changelog

Find info on the latest releases with a detailed changelog in the GitHub Releases tab.

Contribute

If you want to enhance Accenture SFMC DevTools, you can fork the repo and create a pull request. Please understand that we must conduct a code review before accepting your changes.

More details on how to best do that are described in our wiki.

Main Contacts

The people that lead this project:


Jörn Berkefeld

GitHub profile

Doug Midgley

GitHub profile