hardis:project:replacement:list

Description

This command is currently in Beta. Please report any issues or feedback on the sfdx-hardis GitHub repository.

Lists the replacement rules of the project: the rules of every place, the effective rules of every target org, and the built-in rules.

Read-only. With --json, the result holds:

definitions: every rule as stored, with its place (project, branch, issue) and the lower places it changes.
effective: for each major branch, and default (dev sandboxes and scratch orgs), the rules after the merge of the places, whether they apply, and where their value comes from. Secrets only show the CI/CD variable names they are read from, never a value.
builtInRules: the elements removed according to the deployment API version of the target org, and their state.
layers, majorBranches, secretLookups, issues (invalid rules).

The VS Code Replacement Rules panel reads this result.

See Replacement rules for the full reference.

sf hardis:project:replacement:list --agent --json

No prompt: the command is read-only. --skip-issue avoids the call to the git provider.

Technical explanations

Reads config/.sfdx-hardis.yml, every config/branches/.sfdx-hardis.*.yml and the YAML block of the "sfdx-hardis Replacement Rules" issue of the git provider.
The merge is the one of the deployments (mergeReplacementRules): built-in, project, branch file of the target, issue.

Name	Type	Description
agent	boolean	Run in non-interactive mode for agents and automation
debug -d	boolean	Activate debug mode (more logs)
flags-dir	option	Import flag values from a directory.
json	boolean	Format output as json.
skip-issue	boolean	Do not read the rules of the git provider issue
target-branch	option	Only compute the effective rules of this major branch
websocket	option	Websocket host:port for VsCode SFDX Hardis UI integration

$ sf hardis:project:replacement:list

$ sf hardis:project:replacement:list --agent --json

$ sf hardis:project:replacement:list --target-branch uat --json