README.md

sfdx-hardis

Presented at Dreamforce 23 and Dreamforce 24!

Upgrade now to sfdx-hardis v5 !

Toolbox for Salesforce DX, by Cloudity & friends, natively compliant with most platforms and tools.

It will allow you to:

• Do with simple commands what could be done manually in minutes/hours
• Define a ready to use CI/CD Pipeline for your Salesforce project
• Backup Metadatas and monitor any Salesforce org

Please see the full list of commands in Online documentation

---

sfdx-hardis commands are also available with UI in SFDX Hardis Visual Studio Code Extension

---

See Dreamforce presentation

Installation

With IDE

You can install Visual Studio Code extension VsCode SFDX Hardis

Once installed, click on in VsCode left bar, and follow the additional installation instructions

---

As SFDX Plugin

Pre-requisites

• Install Node.js (recommended version)
• Install Salesforce DX by running npm install @salesforce/cli --global command line

Plugin installation

sf plugins install sfdx-hardis

For advanced use, please also install dependencies

sf plugins install @salesforce/plugin-packaging
sf plugins install sfdmu
sf plugins install sfdx-git-delta
sf plugins install texei-sfdx-plugin

If you are using CI/CD scripts, use echo y | sf plugins install ... to bypass prompt.

---

Docker

You can use sfdx-hardis docker images to run in CI

• Docker Hub

  • hardisgroupcom/sfdx-hardis:latest (with latest @salesforce/cli version)
  • hardisgroupcom/sfdx-hardis:latest-sfdx-recommended (with recommended @salesforce/cli version, in case the latest version of @salesforce/cli is buggy)

• GitHub Packages (ghcr.io)

  • ghcr.io/hardisgroupcom/sfdx-hardis:latest (with latest @salesforce/cli version)
  • ghcr.io/hardisgroupcom/sfdx-hardis:latest-sfdx-recommended (with recommended @salesforce/cli version, in case the latest version of @salesforce/cli is buggy)

See Dockerfile

Usage

sf hardis:<COMMAND> <OPTIONS>

Articles

Here are some articles about sfdx-hardis

• English

• French
  • Versions d'API Salesforce décommissionnées: Que faire ?
  • Exporter en masse les fichiers d’une org Salesforce
  • Suspendre l’accès aux utilisateurs lors d’une mise en production Salesforce

Contributing

Everyone is welcome to contribute to sfdx-hardis (even juniors: we'll assist you !)

• Install Node.js (recommended version)
• Install typescript by running npm install typescript --global
• Install yarn by running npm install yarn --global
• Install Salesforce DX by running npm install @salesforce/cli --global command line
• Fork this repo and clone it (or just clone if you are an internal contributor)
• At the root of the repository:
  • Run yarn to install dependencies
  • Run sf plugins link to link the local sfdx-hardis to SFDX CLI
  • Run tsc --watch to transpile typescript into js everytime you update a TS file
• Debug commands using NODE_OPTIONS=--inspect-brk sf hardis:somecommand -someparameter somevalue

Dependencies

sfdx-hardis partially relies on the following SFDX Open-Source packages

• Salesforce Data Move Utility
• SFDX Git Delta
• Texei Sfdx Plugin

Contributors

Commands

Read Online Documentation to see everything you can do with SFDX Hardis :)