Repository files navigation

Presented atDreamforce 23andDreamforce 24!

Sfdx-hardis is aCLI and visual productivity tools suite for Salesforce, byCloudity & friends, natively compliant with most Git platforms, messaging tools, ticketing systems and AI providers (including Agentforce).

It is free and Open-Source, and will allow you to simply:

• Deliver your projects withState of the art Salesforce DevOps

• Backup Metadatas andMonitor your Salesforce orgs

• Generate yourProject Documentation with AI

• Enjoy many commands that willsave your minutes, hours or even days in your dailyAdmin or Developer work.

If you need guidance about how to leverage sfdx-hardis to bring more value to your business, Cloudity's international multi-cloud teams of business experts and technical experts can help:contact us !

See online documentation for a better navigation

sfdx-hardis commands and configuration are best used with an UI inSFDX Hardis Visual Studio Code Extension

See Dreamforce presentation

You can installVisual Studio Code, then VSCode ExtensionVsCode SFDX Hardis

Once installed, click on in VsCode left bar, click onInstall dependencies and follow the additional installation instructions :)

When you are all green, you are all good 😊

You can also watch the video tutorial below

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

sf plugins install sfdx-hardis

For advanced use, please also install dependencies

sf plugins install @salesforce/plugin-packagingsf plugins install sfdx-git-deltasf plugins install sfdmu

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

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

All our Docker images are checked for security issues withMegaLinter by OX Security

• LinuxAlpine based images (works on Gitlab)

  • 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)

SeeDockerfile

• LinuxUbuntu based images (works on GitHub, Azure & Bitbucket)

  • hardisgroupcom/sfdx-hardis-ubuntu:latest (with latest @salesforce/cli version)

  • hardisgroupcom/sfdx-hardis-ubuntu: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-ubuntu:latest (with latest @salesforce/cli version)
    • ghcr.io/hardisgroupcom/sfdx-hardis-ubuntu:latest-sfdx-recommended (with recommended @salesforce/cli version, in case the latest version of @salesforce/cli is buggy)

SeeDockerfile-ubuntu

sf hardis:<COMMAND> <OPTIONS>

Why you don't need DevOps vendors tools

Refresh your full sandboxes without needing to reconfigure everything, withMehdi Abdennasser

Salesforce Org Documentation with Open-Source and Agentforce, byTaha Basri

Summer of Docs – Auto-Document Your Salesforce Org Like a Pro, byMariia Pyvovarchuk (Aspect) andRoman Hentschke

Auto-generate your SF project Documentation site with open-source and Agentforce

Auto-generate your SF project Documentation site with open-source and Agentforce, withMariia Pyvovarchuk

Techs for Admins: Afterwork Salesforce Inspector Reloaded & sfdx-hardis, withThomas Prouvot

Save the Day by Monitoring Your Org with Open-Source Tools, withOlga Shirikova

Automate the Monitoring of your Salesforce orgs with open-source tools only!, withYosra Saidani

Easy and complete Salesforce CI/CD with open-source only!, withWojciech Suwiński

Automate the Monitoring of your Salesforce orgs with open-source tools only!, withMaxime Guenego

Easy Salesforce CI/CD with open-source and clicks only thanks to sfdx-hardis!, withJean-Pierre Rizzi

An easy and complete Salesforce CI/CD release management with open-source only !, withAngélique Picoreau

Here are some articles aboutsfdx-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

• Dreamforce 2024 - Save the Day by Monitoring Your Org with Open-Source Tools (with Olga Shirikova)

{target=blank}

• Dreamforce 2023 - Easy Salesforce CI/CD with open-source and clicks only thanks to sfdx-hardis! (with Jean-Pierre Rizzi)

{target=blank}

• Wir Sind Ohana 2024 - Automate the Monitoring of your Salesforce orgs with open-source tools only! (with Yosra Saidani)

{target=blank}

• Apex Hours 2025 - Org monitoring with Grafana + AI generated doc

{target=blank}

• Salesforce Way Podcast #102 - Sfdx-hardis with Nicolas Vuillamy

{target=blank}

• Salesforce Developers Podcast Episode 182: SFDX-Hardis with Nicolas Vuillamy

{target=blank}

• sfdx-hardis 2025 new features overview

{target=blank}

• SFDX-HARDIS – A demo with Nicolas Vuillamy from Cloudity

{target=blank}

• Complete installation tutorial for sfdx-hardis -📖 Documentation

{target=blank}

• Complete CI/CD workflow for Salesforce projects -📖 Documentation

{target=blank}

• How to start a new User Story in sandbox -📖 Documentation

{target=blank}

• How to commit updates and create merge requests -📖 Documentation

{target=blank}

• How to resolve git merge conflicts in Visual Studio Code -📖 Documentation

{target=blank}

• How to install packages in your org -📖 Documentation

{target=blank}

• Configure CI server authentication to Salesforce orgs -📖 Documentation

{target=blank}

• How to configure monitoring for your Salesforce org -📖 Documentation

{target=blank}

• Configure Slack integration for deployment notifications -📖 Documentation

{target=blank}

• How to create a Personal Access Token in GitLab -📖 Documentation

{target=blank}

• How to generate AI-enhanced Salesforce project documentation -📖 Documentation

{target=blank}

• Host your documentation on Cloudflare free tier -📖 Documentation

{target=blank}

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

• Install Node.js (recommended version)
• Install typescript by runningnpm install typescript --global
• Install yarn by runningnpm install yarn --global
• Install Salesforce DX by runningnpm install @salesforce/cli --global command line
• Forkhttps://github.com/hardisgroupcom/sfdx-hardis and clone it (or just clone if you are an internal contributor)
• At the root of the repository:
  • Runyarn to install dependencies
  • Runsf plugins link to link the local sfdx-hardis to SFDX CLI
  • Runtsc --watch to transpile typescript into js everytime you update a TS file
• Debug commands usingNODE_OPTIONS=--inspect-brk sf hardis:somecommand --someparameter somevalue (you can also debug commands using VsCode Sfdx-Hardis setting)

• Install Node.js (recommended version)
• Install typescript by runningnpm install typescript --global
• Install yarn by runningnpm install yarn --global
• Install Visual Studio Code Insiders (download here)
• Forkhttps://github.com/hardisgroupcom/vscode-sfdx-hardis and clone it (or just clone if you are an internal contributor)
• At the root of the repository:
  • Runyarn to install dependencies
• To test your code in the VsCode Extension:
  • Open thevscode-sfdx-hardis folder in VsCode Insiders
  • PressF5 to open a new VsCode window with the extension loaded (or menu Run -> Start Debugging)
  • In the new window, open a Salesforce DX project
  • Run commands from the command palette (Ctrl+Shift+P) or use the buttons in the panel or webviews

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

• SFDX Git Delta
• Salesforce Data Move Utility

sfdx-hardis is primarily led by Nicolas Vuillamy &Cloudity, but has many external contributors that we cant thank enough !

• Roman Hentschke, for building the BitBucket CI/CD integration
• Leo Jokinen, for building the GitHub CI/CD integration
• Mariia Pyvovarchuk, for her work about generating automations documentation
• Matheus Delazeri, for the PDF output of documentation
• Taha Basri, for his work about generating documentation of LWC
• Anush Poudel, for integrating sfdx-hardis with multiple LLMs using langchainJs
• Sebastien Colladon, for providing sfdx-git-delta which is highly used within sfdx-hardis
• Stepan Stepanov, for implementing the deployment modedelta with dependencies
• Shamina Mossodeean, for automating SF decomposed metadata
• Michael Havrilla, for the integration with Vector.dev allowing to provide monitoring logs to external systems like DataDog

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