Home
New: What's new in sfdx-hardis v8 - Deployment Actions are generally available, Pull Request comments are redesigned, and the VS Code extension is rebuilt.
Sfdx-hardis is a CLI and visual productivity tools suite for Salesforce, by Cloudity & friends, natively compliant with most Git platforms, messaging tools, ticketing systems and AI providers (including Agentforce).
It is free and open-source, and lets you:
- Use many commands that save minutes, hours or even days of your daily admin or developer work.
If you need help to get the most out of sfdx-hardis, Cloudity's international teams of business and technical experts can help: contact us.
See online documentation for a better navigation
sfdx-hardis commands and configuration are best used from the SFDX Hardis Visual Studio Code extension
Featured on SalesforceBen
See Dreamforce presentation
Installation
Which installation do I need?
There are three ways to install sfdx-hardis, and you only need one of them.
| Your situation | What to install | Terminal needed |
|---|---|---|
| You want to use sfdx-hardis on your computer, with menus and buttons instead of commands. This is how most people use it. | Visual Studio Code and the SFDX Hardis extension | No |
| You are at ease with a terminal and only want the commands. | The sfdx-hardis plugin for Salesforce CLI | Yes |
| You are setting up a CI/CD pipeline (GitHub, GitLab, Azure, Bitbucket). | A ready to use Docker image | Yes |
Not sure? Take the first one: it also installs the command line version for you.
Install with Visual Studio Code (recommended)
Visual Studio Code, usually shortened to VS Code, is a free application published by Microsoft. sfdx-hardis runs inside it and adds its own menus and buttons, so you can use every feature without typing a single command.
You do not need to know VS Code, or to write code, to follow the five steps below. Plan about 15 minutes, mostly waiting for downloads.
Step 1: Install Visual Studio Code
Go to code.visualstudio.com, download the version for your system (Windows, macOS or Linux), then run the downloaded file and keep the proposed options.
If VS Code is already on your computer, jump to step 2.
Step 2: Install the SFDX Hardis extension
- Start VS Code.
- In the vertical bar of icons on the left, called the Activity Bar, click the Extensions icon
(four small squares, the top right one tilted). Keyboard shortcut: Ctrl+Shift+X, orCmd+Shift+Xon macOS. - Type
sfdx hardisin the search box. - Click SFDX Hardis in the results, then click Install.
- If VS Code asks whether you trust the publisher, accept: the extension is published by NicolasVuillamy, the author of sfdx-hardis.
You can also do it from your browser: open the SFDX Hardis page on the Visual Studio Marketplace, click Install, and let the browser hand over to VS Code.
Step 3: Open the sfdx-hardis panel
Once the extension is installed, a new icon 
appears in the Activity Bar, on the left. Click it (arrow 1 below): the sfdx-hardis menus appear, and the Welcome page opens.
At the top of the Welcome page, click the dependencies button (arrow 2 below).
Step 4: Install the dependencies
To talk to Salesforce and to Git, sfdx-hardis needs a few other free tools. The setup page lists them all, with a green check on those you already have.
- Click Install or Upgrade on every line that is not green, or click Run pending installs to handle them one after the other.
- Node.js and Git are the two you may have to install by yourself: download them from nodejs.org and git-scm.com, then click Re-check on the line.
- Close VS Code and open it again at the end, so it sees the newly installed tools.
When every line is green, the installation is over.
Step 5: Connect to your Salesforce org
Go back to the Welcome page and click Connect to log in to your first org. The same page then gives you access to all the features.
Where to go next:
- What you can do from the VS Code extension
- Set up a Salesforce CI/CD project
- Monitor a Salesforce org
Video tutorial
If you prefer to watch someone do it first, follow the video below.
If something does not work
- A line stays red after you installed the tool: close VS Code, open it again, then click Re-check on that line.
- A command does nothing: open the setup page again, a dependency may still be missing or outdated.
- Still stuck? Open a GitHub issue, the maintainers and the community answer there.
Other VS Code compatible IDEs
The extension is published on both the Visual Studio Marketplace and the Open VSX Registry, so the steps above also work in the IDEs built on VS Code, on desktop or in the browser.
| IDE | Install from | |
|---|---|---|
 |
Visual Studio Code | Visual Studio Marketplace |
 |
Agentforce Vibes IDE and other browser IDEs | Open VSX |
   |
Cursor, Windsurf, VSCodium and other VS Code forks | Open VSX |
The only requirement is the same as for VS Code: the IDE must be able to run the Salesforce CLI (Agentforce Vibes IDE ships it preinstalled).
Install as a Salesforce CLI plugin
For those who prefer to type commands in a terminal. If you followed the VS Code steps above, this is already done.
Pre-requisites
- Install Node.js (recommended version)
- Install the Salesforce CLI by running
npm install @salesforce/cli --global
Plugin installation
sf plugins install sfdx-hardis
For advanced use, please also install dependencies
sf plugins install @salesforce/plugin-packaging
sf plugins install sfdx-git-delta
sf plugins install sfdmu
If you are using CI/CD scripts, use echo y | sf plugins install ... to bypass prompt.
Run in CI/CD with a Docker image
For pipelines: the images already contain Node.js, the Salesforce CLI, sfdx-hardis and its plugins, so a job starts without installing anything.
All our Docker images are checked for security issues with MegaLinter by OX Security
Images are published on both GitHub Container Registry (ghcr.io) and Docker Hub. Prefer the ghcr.io images: their publication does not rely on any long-lived token (it is secured with the workflow's ephemeral credentials), so they have the most secure supply chain. Use the Docker Hub mirror images when your infrastructure can only pull from
docker.io.
Two image flavors are available:
- Standard images (
sfdx-hardis,sfdx-hardis-ubuntu): Salesforce CI/CD tooling without coding agent CLIs. Use these for standard deployments.
- With-agents images (
sfdx-hardis-with-agents,sfdx-hardis-ubuntu-with-agents): Same as standard + coding agent CLIs pre-installed (Claude, Codex, Gemini, GitHub Copilot). Use these for AI-powered auto-fix scenarios.
Standard images (without coding agent CLIs)
-
Linux Alpine based images (works on GitLab)
-
GitHub Container Registry (recommended)
- 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)
-
Docker Hub (mirror)
- 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)
-
See Dockerfile
-
Linux Ubuntu based images (works on GitHub, Azure & Bitbucket)
-
GitHub Container Registry (recommended)
- 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)
-
Docker Hub (mirror)
- 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)
-
With-agents images (includes coding agent CLIs)
These images include Claude Code, OpenAI Codex, Gemini CLI, and GitHub Copilot pre-installed and are required for the AI coding agent auto-fix feature.
Note: Alpine-based with-agents images may have limitations with some agent CLIs at runtime due to musl libc. Use Ubuntu-based images for full agent compatibility.
-
Linux Alpine based images (works on GitLab)
- GitHub Container Registry (recommended): ghcr.io/hardisgroupcom/sfdx-hardis-with-agents:latest
- Docker Hub (mirror): hardisgroupcom/sfdx-hardis-with-agents:latest
See Dockerfile
-
Linux Ubuntu based images (works on GitHub, Azure & Bitbucket - recommended for coding agents)
- GitHub Container Registry (recommended): ghcr.io/hardisgroupcom/sfdx-hardis-ubuntu-with-agents:latest
- Docker Hub (mirror): hardisgroupcom/sfdx-hardis-ubuntu-with-agents:latest
Usage
sf hardis:<COMMAND> <OPTIONS>
Events
North Africa Dreamin' 2026, Casablanca (upcoming)
Casablanca, Morocco - 24/10/2026
Czech Dreamin '26, Prague
Refresh your full sandboxes without needing to reconfigure everything
Prague, Czechia - 29/05/2026
Wir Sind Ohana '26, Berlin
When was the last time you refreshed your sandboxes to have fresh data?
Berlin, Germany - 08/05/2026
Dream Ole '26, Valencia
Refresh your full sandboxes without needing to reconfigure everything, with Louise Lockie
Valencia, Spain - 27/03/2026
Polish Dreamin '26, Wroclaw
Refresh your full sandboxes without needing to reconfigure everything
Wroclaw, Poland - 20/03/2026
Irish Dreamin '26, Dublin
No-Cost DevOps: Enterprise-Grade CI/CD with SFDX-HARDIS, by Abdeslam Loukili
Dublin, Ireland - 19/03/2026
French Touch Dreamin '25
Refresh your full sandboxes without needing to reconfigure everything - with Mehdi Abdennasser
Paris, France - 02/12/2025
DevOps Dreamin
Why you don't need DevOps vendors tools
London, UK - 20/11/2025
Trailblazer User Group '25, Casablanca
Salesforce Org Documentation with Open-Source and Agentforce, by Taha Basri
Trailblazer Developer Group '25, Berlin (online)
Summer of Docs: Auto-Document Your Salesforce Org Like a Pro, by Mariia Pyvovarchuk (Aspect) and Roman Hentschke
London's Calling '25, London
Auto-generate your SF project Documentation site with open-source and Agentforce
Czech Dreamin '25, Prague
Auto-generate your SF project Documentation site with open-source and Agentforce, with Mariia Pyvovarchuk
Trailblazer Admin Group '25, Lyon
Techs for Admins: Afterwork Salesforce Inspector Reloaded & sfdx-hardis, with Thomas Prouvot
Dreamforce 2024, San Francisco
Save the Day by Monitoring Your Org with Open-Source Tools, with Olga Shirikova
Wir Sind Ohana '24, Berlin
Automate the Monitoring of your Salesforce orgs with open-source tools only!, with Yosra Saidani
Polish Dreamin '24, Wroclaw, Poland
Easy and complete Salesforce CI/CD with open-source only!, with Wojciech Suwiński
French Touch Dreamin '23, Paris
Automate the Monitoring of your Salesforce orgs with open-source tools only!, with Maxime Guenego
Dreamforce 2023, San Francisco
Easy Salesforce CI/CD with open-source and clicks only thanks to sfdx-hardis!, with Jean-Pierre Rizzi
Yeur Dreamin' 2023, Brussels
An easy and complete Salesforce CI/CD release management with open-source only !, with Angélique Picoreau
Articles & Videos
Web Articles
Here are some articles about sfdx-hardis
- English
- French
Recorded Conferences
Dreamforce Sessions
- Dreamforce 2024 - Save the Day by Monitoring Your Org with Open-Source Tools (with Olga Shirikova)
- Dreamforce 2023 - Easy Salesforce CI/CD with open-source and clicks only thanks to sfdx-hardis! (with Jean-Pierre Rizzi)
Community Events
- Wir Sind Ohana 2024 - Automate the Monitoring of your Salesforce orgs with open-source tools only! (with Yosra Saidani)
Podcasts
- SalesforceBen Deep Dives with Peter Chittum, 2025: Simplify Salesforce Deployment with SFDX Hardis
- Apex Hours 2025 - Org monitoring with Grafana + AI generated doc
- Salesforce Way Podcast #102 - Sfdx-hardis with Nicolas Vuillamy
- Salesforce Developers Podcast Episode 182: SFDX-Hardis with Nicolas Vuillamy
sfdx-hardis Usage
Features Overview
- sfdx-hardis 2025 new features overview
- SFDX-HARDIS: A demo with Nicolas Vuillamy from Cloudity
Installation & Setup
- Complete installation tutorial for sfdx-hardis - 📖 Documentation
CI/CD Workflows
- Complete CI/CD workflow for Salesforce projects - 📖 Documentation
- How to start a new User Story in sandbox - 📖 Documentation
- How to commit updates and create merge requests - 📖 Documentation
- How to resolve git merge conflicts in Visual Studio Code - 📖 Documentation
- How to install packages in your org - 📖 Documentation
- Configure CI server authentication to Salesforce orgs - 📖 Documentation
Monitoring
- How to configure monitoring for your Salesforce org - 📖 Documentation
Integrations
- Configure Slack integration for deployment notifications - 📖 Documentation
- How to create a Personal Access Token in GitLab - 📖 Documentation
Documentation
- How to generate AI-enhanced Salesforce project documentation - 📖 Documentation
- Host your documentation on Cloudflare free tier - 📖 Documentation
Contributing
Everyone is welcome to contribute to sfdx-hardis (even juniors: we will help you).
Salesforce CLI Plugin: sfdx-hardis
- Install Node.js (recommended version)
- Install TypeScript by running
npm install typescript --global - Install yarn by running
npm install yarn --global - Install the Salesforce CLI by running
npm install @salesforce/cli --global - Fork https://github.com/hardisgroupcom/sfdx-hardis and clone it (or just clone if you are an internal contributor)
- At the root of the repository:
- Run
yarnto install dependencies - Run
sf plugins linkto link the local sfdx-hardis to the Salesforce CLI - Run
tsc --watchto transpile TypeScript into JavaScript every time you update a TS file
- Run
- Debug commands using
NODE_OPTIONS=--inspect-brk sf hardis:somecommand --someparameter somevalue(you can also debug commands with the VS Code SFDX Hardis extension debug setting)
Note: To test a feature from CI, you can add the following code in your workflow before running sfdx-hardis commands:
REPO_URL="https://github.com/hardisgroupcom/sfdx-hardis.git" # or your forked repo URL
GIT_BRANCH="fixes/my-git-branch" # or the branch you want to test
TEMP_DIR=$(mktemp -d)
git clone "$REPO_URL" "$TEMP_DIR"
cd "$TEMP_DIR"
git checkout "$GIT_BRANCH"
yarn
npm install typescript --global
tsc
sf plugins link
cd -
VS Code Extension: vscode-sfdx-hardis
- Install Node.js (recommended version)
- Install TypeScript by running
npm install typescript --global - Install yarn by running
npm install yarn --global - Install Visual Studio Code Insiders (download here)
- Fork https://github.com/hardisgroupcom/vscode-sfdx-hardis and clone it (or just clone if you are an internal contributor)
- At the root of the repository:
- Run
yarnto install dependencies
- Run
- To test your code in the VS Code extension:
- Open the
vscode-sfdx-hardisfolder in VS Code Insiders - Press
F5to open a new VS Code 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
- Open the
Dependencies
sfdx-hardis partially relies on the following SFDX Open-Source packages
Contributors
Organization
sfdx-hardis is primarily led by Nicolas Vuillamy & Cloudity, but has many external contributors that we cant thank enough !
Pull Requests Authors
Special Thanks
- Roman Hentschke, for building the BitBucket CI/CD integration and german translation
- 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 and brazilian-portuguese translation
- 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 mode delta 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
- Teoman Sertcelik, for allowing to configure authentication using External Client App
- Fernando Fernandez, for the great command that detects objects fields usage
- Yamilet Oliva, for sfdx-hardis spanish translation and the enriched Flow error monitoring notifications
- Shinnosuke Takakura, for sfdx-hardis japanese translation
- Dagmara Ryborz, for Polish translation
- Matt Carvin, for the underused permission sets command and the real deployment metrics of smart deploy
- Salik Lennert Pedersen, for his numerous bug fixes, the hardis:mdapi:read and hardis:mdapi:upsert commands, git worktrees support and Flow deletion in destructive changes
- Ryad Meguimi, for the Light & Dark modes and the whole refactoring of CSS
- Nicholas Fiorendi, for Italian translation
- Timo Pouw, for Dutch translation
- Quentin Tiercelin, for the commands to detect unsecure permissions and generate a data dictionary
- Pranay Jaiswal, for smarter audit trail monitoring with allowed actions per user
- Maciej Ptak, for fixing Flow git diff on projects with custom package directories
- Eric Mulder, for revising the sandbox setup and best practices documentation
- Maxime Guenego, for the metadata lint commands: unused metadata, inactive metadata and missing descriptions
- Meric Asaner, for the unused users detection and bulkified Flow deletions
- Brahim Laissaoui, for major files export improvements (batched processing, Attachments support)
- Dimitri Monge, for the user freeze/unfreeze commands and the Jenkins and GitHub Actions pipeline templates
- zzyviolette, for restoring Connected Apps after a sandbox refresh
- Yan Imensar, for the MS Teams notifications integration
- Maksym Petrov, for Apex Trigger support in project documentation generation and CI runner cost savings
- Manoel Calixto, for robustness fixes on sources cleaning and Flow documentation
- Piotr, for the files export filename format options
- Thomas Prouvot, for the Experience Cloud communities activation command
- JMMlw, for the profile purge command
- mbobard, for the System.debug cleaning command
- Juliano de Medeiros Machado, for keeping original translations in custom label translations
- Alain Bates, for the Bitbucket Git provider support
- Theodoor van Donge, for switching Apex logs purge to the Tooling API
- Kris Goncalves, for the option to hide Apex code in generated project documentation
- Clément Fernandez, for the metadata duplicates detection command and many early improvements
- Mehdi, for the bypass generation command and its application to Flows, Validation Rules and Triggers
- Mathieu Rodrigues, for the SFDMU configuration for CPQ projects
- Hasnioui-Ysf, for the work on Permission Sets management
Translations have been performed by GitHub Copilot with Claude Sonnet 4.6, then reviewed and arranged by real humans !
- English: Nicolas Vuillamy (if someone is interested to make better english, please contact me !)
- French: Nicolas Vuillamy
- Spanish: Yamilet Oliva
- German: Roman Hentschke
- Polish: Dagmara Ryborz
- Japanese: Shinnosuke Takakura
- Brazilian-portuguese: Matheus Delazeri
- Italian: Nicholas Fiorendi
- Dutch: Timo Pouw
Commands
hardis:auth
| Command | Title |
|---|---|
| hardis:auth:login |
hardis:cache
| Command | Title |
|---|---|
| hardis:cache:clear |
hardis:config
| Command | Title |
|---|---|
| hardis:config:get | |
| hardis:config:monitoring-defaults |
hardis:datacloud
| Command | Title |
|---|---|
| hardis:datacloud:extract:agentforce-conversations | |
| hardis:datacloud:extract:agentforce-feedback | |
| hardis:datacloud:sql-query |
hardis:deploy
| Command | Title |
|---|---|
| hardis:deploy:quick | |
| hardis:deploy:start | |
| hardis:deploy:validate |
hardis:doc
hardis:doctor
| Command | Title |
|---|---|
| hardis:doctor |
hardis:git
| Command | Title |
|---|---|
| hardis:git:pull-requests:extract |
hardis:lint
| Command | Title |
|---|---|
| hardis:lint:access | |
| hardis:lint:metadatastatus | |
| hardis:lint:missingattributes | |
| hardis:lint:unusedmetadatas |
hardis:mdapi
| Command | Title |
|---|---|
| hardis:mdapi:deploy | |
| hardis:mdapi:read | |
| hardis:mdapi:upsert |
hardis:misc
| Command | Title |
|---|---|
| hardis:misc:custom-label-translations | |
| hardis:misc:purge-references | |
| hardis:misc:servicenow-report | |
| hardis:misc:toml2csv |
hardis:org
hardis:package
| Command | Title |
|---|---|
hardis create |
|
| hardisinstall |
|
| hardismergexml |
|
| hardisversion:create |
|
| hardisversion:list |
|
| hardisversion:promote |
hardis:packagexml
| Command | Title |
|---|---|
| hardis:packagexml:append | |
| hardis:packagexml:remove | |
| hardis:packagexml:remove-managed |
hardis:project
hardis:scratch
hardis:source
| Command | Title |
|---|---|
| hardis:source:deploy | |
| hardis:source:push | |
| hardis:source:retrieve |
hardis:work
| Command | Title |
|---|---|
| hardis:work:backpromote | |
| hardis:work:new | |
| hardis:work:refresh | |
| hardis:work:resetselection | |
| hardis:work:save | |
| hardis:work:ws |
hello:world
| Command | Title |
|---|---|
| hello:world |