Installation.


Table of Contents



Prerequisites.

Before installing and using this Plugin make sure you've already have the SF CLI platform installed on your system.

See the this article how to install the SF CLI.

Installation.

The simplest way to install is using SFDMU as a standard SFDX plugin.

This would be the recommended way for installing the SFDMU, since it will install and use the production version of the Plugin:

# If you have an old version of the Plugin, uninstall it:
$ sf plugins uninstall sfdmu

# Install the latest version of the Plugin:
$ sf plugins install sfdmu

Installation as the cloned source code (for the debugging purposes):

# If you have outdated source code already cloned and linked, go to the directory containing old Plugin source code and unlink it from the SFDX by typing:
$ sf plugins unlink

# Then clone the latest source code:
$ git clone https://github.com/forcedotcom/SFDX-Data-Move-Utility

# 2. Make the installation directory current:
$ cd SFDX-Data-Move-Utility

# 3. Install npm modules:
$ npm install

# 4. Link the Plugin to the SFDX:
$ sf plugins link
Notes:
  • When installing and running the SFDMU on MacOS you can sometimes run into a permission issue. If so, just prepend all above command with "sudo", e.g.:

    $ sudo sf plugins install sfdmu

  • All examples are provided with the assumption that you are using the current SF-CLI platform. However, if you are operating under the outdated SFDX CLI platform, you should replace sf by sfdx and : by a space, for example: sfdx plugins:install sfdmu instead of sf plugins install sfdmu

Last updated on 15th Mar 2024