Aura Helper SF


SF CLI Plugin to work with Salesforce Projects. This application are entire developed using Aura Helper Framework and has powerfull commands to manage your projects, create Continous Integration and DevOps workflows and support developers to make some utils task on every project like import and export data, create package files (including from git differences), compare metadata from two orgs or from your local project and the auth org, and to much more. It is the Aura Helper CLI natural evolution to integrate better to other salesforce tools.

Features

- Simplify your work with Salesforce and Git with the command for create packages (for deploy and delete) from git changes. Compare two _branches_, _commits_ or _tags_ for create the files for deploy your package.
- Repair file _dependencies errors_ on your project files or Check only to resolve errors manually.
- Compress your XML Files structure for make easy _identify changes_ and resolve _git conflicts_. Also need less storage and work faster.
- Retrieve special Metadata Types like _profiles_ or _permissions_ sets (and others) with all data without retrieve any file more with a simple command. Also can Retrieve special Metadata Types from the connected org.
- Compare your _local data_ with your _authorized organization_ for get the differences for delete, retrieve or anything you want. Or Compare the Metadata Types _between two orgs_ to see the differences.
- Merge diferent package or destructive files into one file with only one command.
- Ignore any metadata type from your local project or from the package files for maintance different configuration into your sandbox and production enviroments with simple file and command.
- Specially designed for DevOps workflows.
- Code Quality Report with SFDX Scanner, Quality Gates to control the quality of your code like SonarQube, with integration with CI and DevOps tools. Also create an HTML Report with statistics and details of the code analisys.
- And much more

$3

---

Supported Operative Systems:

- Windows
- Linux
- Mac OS X

---

_Table of Contents_

- Aura Helper SF
- Features
- Specially Designed for DevOps Workflows
- _Table of Contents_
- Installation Guide
- SF CLI Plugins manager (Recommended)
- NPM Installation
- Clone Repository Installation
- Aura Helper SF Commands
- sf ah apex execute
- sf ah apex execute org
- sf ah apex org execute
- sf ah compare metadata
- sf ah compare org
- sf ah compress
- sf ah compress xml
- sf ah data export
- sf ah data import
- sf ah execute apex
- sf ah execute apex org
- sf ah execute org apex
- sf ah get org permissions
- sf ah get permissions org
- sf ah git tests extract
- sf ah local retrieve special
- sf ah local special retrieve
- sf ah logs clean
- sf ah metadata compare
- sf ah metadata local compress
- sf ah metadata local describe
- sf ah metadata local ignore
- sf ah metadata local list
- sf ah metadata local repair
- sf ah metadata local special retrieve
- sf ah metadata org apex execute
- sf ah metadata org apex tests extract
- sf ah metadata org compare
- sf ah metadata org describe
- sf ah metadata org list
- sf ah metadata org permissions get
- sf ah metadata org special retrieve
- sf ah org apex execute
- sf ah org compare
- sf ah org execute apex
- sf ah org get permissions
- sf ah org permissions get
- sf ah org retrieve special
- sf ah org special retrieve
- sf ah package git create
- sf ah package json convert
- sf ah package json create
- sf ah package merge
- sf ah permissions get org
- sf ah permissions org get
- sf ah scan report open
- sf ah scan report quality
- sf ah scan report run
- sf ah special local retrieve
- sf ah special org retrieve
- sf ah version
- sf ah xml compress
- Ignore File
- Example:
- IMPORTANT
- Metadata JSON Format
- Example:
- Dependencies Repair Response
- Example:
- Dependencies Check Response
- Example:
- Issues
- Contributing
- CLA
- Build

---

Installation Guide

You can install the plugins using SF CLI plugins manager or cloning the repository and link it with SF CLI.

SF CLI Plugins manager (Recommended)

To install Aura Helper SF CLI run the next command:

sf plugins install aura-helper-sf

NPM Installation

To install Aura Helper SF run the next command:

npm install -g aura-helper-sf

Clone Repository Installation

To install cloning the source code repository, follow the next steps

1. Clone the repository
2. Go to the root project folder
3. Run the next command

sf plugins link

Aura Helper SF Commands

All commands from Aura Helper SF have the next structure:

sf [command:input] [options]

Al commands start by ah. For example

sf ah topic command [command:input] [options]

---

sf ah apex execute

Execute Anonymous Apex N Times.

``
USAGE
$ sf ah apex execute --file [--json] [-r ] [-o ] [-a ] [-i ] [-l -p]

FLAGS
-a, --api-version= API version to use if different from the default
-i, --iterations= [default: 1] Script execution number
-l, --print-log Print Log every execution
-o, --target-org= Login username or alias for the target org
-p, --progress Report Command Progress
-r, --root= [default: ./] Root Project Path
--file= (required) Script File Path

GLOBAL FLAGS
--json Format output as json.

DESCRIPTION
Execute Anonymous Apex N Times.

Command to execute an Anonymous Apex script from file against the auth org N times.

ALIASES
$ sf ah execute org apex
$ sf ah execute apex org
$ sf ah apex execute org
$ sf ah apex org execute
$ sf ah org execute apex
$ sf ah org apex execute
$ sf ah apex execute
$ sf ah execute apex

EXAMPLES
Execute a script 3 times

$ sf ah apex execute -f "path/to/script.apex" -i 3

Execute a script 10 times and print the execution log

$ sf ah apex execute -f "path/to/script.apex" --iterations 10 --print-log

FLAG DESCRIPTIONS
-a, --api-version= API version to use if different from the default

API version to use if different from the default

-i, --iterations= Script execution number

Option to select the scritp execution number. For example, 3 for execute the script 3 times

-l, --print-log Print Log every execution

Option to print the result log of every execution. Depends on --progress flag

-o, --target-org= Login username or alias for the target org

Overrides your default org

-p, --progress Report Command Progress

Option to report the command progress (into the selected format) or show a spinner loader

-r, --root= Root Project Path

Path to project root. By default is your current folder

--file= Script File Path

Path to the Anonymous Apex Script file
`

sf ah apex execute org

Execute Anonymous Apex N Times.

`
USAGE
$ sf ah apex execute org --file [--json] [-r ] [-o ] [-a ] [-i ] [-l -p]

FLAGS
-a, --api-version= API version to use if different from the default
-i, --iterations= [default: 1] Script execution number
-l, --print-log Print Log every execution
-o, --target-org= Login username or alias for the target org
-p, --progress Report Command Progress
-r, --root= [default: ./] Root Project Path
--file= (required) Script File Path

GLOBAL FLAGS
--json Format output as json.

DESCRIPTION
Execute Anonymous Apex N Times.

Command to execute an Anonymous Apex script from file against the auth org N times.

ALIASES
$ sf ah execute org apex
$ sf ah execute apex org
$ sf ah apex execute org
$ sf ah apex org execute
$ sf ah org execute apex
$ sf ah org apex execute
$ sf ah apex execute
$ sf ah execute apex

EXAMPLES
Execute a script 3 times

$ sf ah apex execute org -f "path/to/script.apex" -i 3

Execute a script 10 times and print the execution log

$ sf ah apex execute org -f "path/to/script.apex" --iterations 10 --print-log

FLAG DESCRIPTIONS
-a, --api-version= API version to use if different from the default

API version to use if different from the default

-i, --iterations= Script execution number

Option to select the scritp execution number. For example, 3 for execute the script 3 times

-l, --print-log Print Log every execution

Option to print the result log of every execution. Depends on --progress flag

-o, --target-org= Login username or alias for the target org

Overrides your default org

-p, --progress Report Command Progress

Option to report the command progress (into the selected format) or show a spinner loader

-r, --root= Root Project Path

Path to project root. By default is your current folder

--file= Script File Path

Path to the Anonymous Apex Script file
`

sf ah apex org execute

Execute Anonymous Apex N Times.

`
USAGE
$ sf ah apex org execute --file [--json] [-r ] [-o ] [-a ] [-i ] [-l -p]

FLAGS
-a, --api-version= API version to use if different from the default
-i, --iterations= [default: 1] Script execution number
-l, --print-log Print Log every execution
-o, --target-org= Login username or alias for the target org
-p, --progress Report Command Progress
-r, --root= [default: ./] Root Project Path
--file= (required) Script File Path

GLOBAL FLAGS
--json Format output as json.

DESCRIPTION
Execute Anonymous Apex N Times.

Command to execute an Anonymous Apex script from file against the auth org N times.

ALIASES
$ sf ah execute org apex
$ sf ah execute apex org
$ sf ah apex execute org
$ sf ah apex org execute
$ sf ah org execute apex
$ sf ah org apex execute
$ sf ah apex execute
$ sf ah execute apex

EXAMPLES
Execute a script 3 times

$ sf ah apex org execute -f "path/to/script.apex" -i 3

Execute a script 10 times and print the execution log

$ sf ah apex org execute -f "path/to/script.apex" --iterations 10 --print-log

FLAG DESCRIPTIONS
-a, --api-version= API version to use if different from the default

API version to use if different from the default

-i, --iterations= Script execution number

Option to select the scritp execution number. For example, 3 for execute the script 3 times

-l, --print-log Print Log every execution

Option to print the result log of every execution. Depends on --progress flag

-o, --target-org= Login username or alias for the target org

Overrides your default org

-p, --progress Report Command Progress

Option to report the command progress (into the selected format) or show a spinner loader

-r, --root= Root Project Path

Path to project root. By default is your current folder

--file= Script File Path

Path to the Anonymous Apex Script file
`

sf ah compare metadata

Compare Metadata Types and Objects between two orgs or between your local project and your auth org

`
USAGE
$ sf ah compare metadata -o [--json] [-r ] [-s ] [-a ] [-p] [--output-file ]
[--csv]

FLAGS
-a, --api-version= API version to use if different from the default
-o, --target-org= (required) Target Org to Compare.
-p, --progress Report Command Progress
-r, --root= [default: ./] Root Project Path
-s, --source-org= Source Org to compare.
--csv Show the result as CSV
--output-file= Output file

GLOBAL FLAGS
--json Format output as json.

DESCRIPTION
Compare Metadata Types and Objects between two orgs or between your local project and your auth org

Command to compare your local project with your auth org for get the differences. The result are the metadata types
and objects that you have in your org, but don't have in your local project. Also can compare between two different
orgs and return the metadata that exists on target org but not exists on source org

ALIASES
$ sf ah metadata compare
$ sf ah compare metadata
$ sf ah org compare
$ sf ah compare org

EXAMPLES
Compare Metadata Types and Objects between your local project and your auth org

$ sf ah compare metadata -o test.username@salesforceOrg.com.qa

Compare Metadata Types and Objects between two orgs

$ sf ah compare metadata -s test.username@salesforceOrg.com.uat -o test.username@salesforceOrg.com.qa

Compare Metadata Types and Objects between your local project and your auth org and show the result as CSV

$ sf ah compare metadata -t test.username@salesforceOrg.com.qa --csv

Compare Metadata Types and Objects between your local project and your auth org and show the result as JSON

$ sf ah compare metadata -t test.username@salesforceOrg.com.qa --json

FLAG DESCRIPTIONS
-a, --api-version= API version to use if different from the default

API version to use if different from the default

-o, --target-org= Target Org to Compare.

Target Salesforce org to compare.

-p, --progress Report Command Progress

Option to report the command progress (into the selected format) or show a spinner loader

-r, --root= Root Project Path

Path to project root. By default is your current folder

-s, --source-org= Source Org to compare.

Source Salesforce org to compare. If you choose source, --root will be ignored. If you not choose source, the
command will compare your local project with your auth org

--csv Show the result as CSV

Option to show the result as CSV instead a table if not select --json flag

--output-file= Output file

Path to file for redirect the output
`

sf ah compare org

Compare Metadata Types and Objects between two orgs or between your local project and your auth org

`
USAGE
$ sf ah compare org -o [--json] [-r ] [-s ] [-a ] [-p] [--output-file ] [--csv]

FLAGS
-a, --api-version= API version to use if different from the default
-o, --target-org= (required) Target Org to Compare.
-p, --progress Report Command Progress
-r, --root= [default: ./] Root Project Path
-s, --source-org= Source Org to compare.
--csv Show the result as CSV
--output-file= Output file

GLOBAL FLAGS
--json Format output as json.

DESCRIPTION
Compare Metadata Types and Objects between two orgs or between your local project and your auth org

Command to compare your local project with your auth org for get the differences. The result are the metadata types
and objects that you have in your org, but don't have in your local project. Also can compare between two different
orgs and return the metadata that exists on target org but not exists on source org

ALIASES
$ sf ah metadata compare
$ sf ah compare metadata
$ sf ah org compare
$ sf ah compare org

EXAMPLES
Compare Metadata Types and Objects between your local project and your auth org

$ sf ah compare org -o test.username@salesforceOrg.com.qa

Compare Metadata Types and Objects between two orgs

$ sf ah compare org -s test.username@salesforceOrg.com.uat -o test.username@salesforceOrg.com.qa

Compare Metadata Types and Objects between your local project and your auth org and show the result as CSV

$ sf ah compare org -t test.username@salesforceOrg.com.qa --csv

Compare Metadata Types and Objects between your local project and your auth org and show the result as JSON

$ sf ah compare org -t test.username@salesforceOrg.com.qa --json

FLAG DESCRIPTIONS
-a, --api-version= API version to use if different from the default

API version to use if different from the default

-o, --target-org= Target Org to Compare.

Target Salesforce org to compare.

-p, --progress Report Command Progress

Option to report the command progress (into the selected format) or show a spinner loader

-r, --root= Root Project Path

Path to project root. By default is your current folder

-s, --source-org= Source Org to compare.

Source Salesforce org to compare. If you choose source, --root will be ignored. If you not choose source, the
command will compare your local project with your auth org

--csv Show the result as CSV

Option to show the result as CSV instead a table if not select --json flag

--output-file= Output file

Path to file for redirect the output
`

sf ah compress

Compress XML Metadata Files.

`
USAGE
$ sf ah compress [--json] [-r ] [--all | -f | -d ] [--sort-order
simpleFirst|complexFirst|alphabetAsc|alphabetDesc]

FLAGS
-d, --directory=... Compress XML Files from specific directory
-f, --file=... Compress XML Files from specific directory
-r, --root= [default: ./] Root Project Path
--all Compress All Project Files
--sort-order= [default: simpleFirst] Sort order for XML Files compression


GLOBAL FLAGS
--json Format output as json.

DESCRIPTION
Compress XML Metadata Files.

Compress XML Metadata Files for best conflict handling with SVC systems. Works with relative or absolute paths.

ALIASES
$ sf ah compress
$ sf ah xml compress
$ sf ah compress xml

EXAMPLES
Compress all project XML Files

$ sf ah compress -a

Compress all XML Files from objects folder (and subfolders)

$ sf ah compress -d force-app/main/default/objects --json

Compress all XML Files from objects folder (and subfolders) and applications folder

$ sf ah compress -d "force-app/main/default/objects" -d "force-app/main/default/applications"

Compress all XML Files from objects folder (and subfolders) and applications folder

$ sf ah compress -d "force-app/main/default/objects, force-app/main/default/applications"

Compress specific XML File with progress report

$ sf ah compress -f "force-app/main/default/objects/Account/Account.object-meta-xml" -p

Compress specific XML Files with JSON output

$ sf ah compress -f "force-app/main/default/objects/Account/Account.object-meta-xml" -f ^
"force-app/main/default/objects/Case/Case.object-meta-xml" --json

Compress specific XML Files with JSON output

$ sf ah compress -f "force-app/main/default/objects/Account/Account.object-meta-xml, ^
force-app/main/default/objects/Case/Case.object-meta-xml" --json

FLAG DESCRIPTIONS
-d, --directory=... Compress XML Files from specific directory

Compress XML Files from specific directory (and subfolders). This options does not take effect if you choose
compress all.

-f, --file=... Compress XML Files from specific directory

Compress XML Files from specific directory (and subfolders). This options does not take effect if you choose
compress all.

-r, --root= Root Project Path

Path to project root. By default is your current folder

--all Compress All Project Files

Compress all XML files with support compression in your project.

--sort-order=simpleFirst|complexFirst|alphabetAsc|alphabetDesc Sort order for XML Files compression

Sort order for the XML elements when compress XML files. By default, the elements are sorted with simple XML
elements first.
`

sf ah compress xml

Compress XML Metadata Files.

`
USAGE
$ sf ah compress xml [--json] [-r ] [--all | -f | -d ] [--sort-order
simpleFirst|complexFirst|alphabetAsc|alphabetDesc]

FLAGS
-d, --directory=... Compress XML Files from specific directory
-f, --file=... Compress XML Files from specific directory
-r, --root= [default: ./] Root Project Path
--all Compress All Project Files
--sort-order= [default: simpleFirst] Sort order for XML Files compression


GLOBAL FLAGS
--json Format output as json.

DESCRIPTION
Compress XML Metadata Files.

Compress XML Metadata Files for best conflict handling with SVC systems. Works with relative or absolute paths.

ALIASES
$ sf ah compress
$ sf ah xml compress
$ sf ah compress xml

EXAMPLES
Compress all project XML Files

$ sf ah compress xml -a

Compress all XML Files from objects folder (and subfolders)

$ sf ah compress xml -d force-app/main/default/objects --json

Compress all XML Files from objects folder (and subfolders) and applications folder

$ sf ah compress xml -d "force-app/main/default/objects" -d "force-app/main/default/applications"

Compress all XML Files from objects folder (and subfolders) and applications folder

$ sf ah compress xml -d "force-app/main/default/objects, force-app/main/default/applications"

Compress specific XML File with progress report

$ sf ah compress xml -f "force-app/main/default/objects/Account/Account.object-meta-xml" -p

Compress specific XML Files with JSON output

$ sf ah compress xml -f "force-app/main/default/objects/Account/Account.object-meta-xml" -f ^
"force-app/main/default/objects/Case/Case.object-meta-xml" --json

Compress specific XML Files with JSON output

$ sf ah compress xml -f "force-app/main/default/objects/Account/Account.object-meta-xml, ^
force-app/main/default/objects/Case/Case.object-meta-xml" --json

FLAG DESCRIPTIONS
-d, --directory=... Compress XML Files from specific directory

Compress XML Files from specific directory (and subfolders). This options does not take effect if you choose
compress all.

-f, --file=... Compress XML Files from specific directory

Compress XML Files from specific directory (and subfolders). This options does not take effect if you choose
compress all.

-r, --root= Root Project Path

Path to project root. By default is your current folder

--all Compress All Project Files

Compress all XML files with support compression in your project.

--sort-order=simpleFirst|complexFirst|alphabetAsc|alphabetDesc Sort order for XML Files compression

Sort order for the XML elements when compress XML files. By default, the elements are sorted with simple XML
elements first.
`

sf ah data export

Export Salesforce Data.

`
USAGE
$ sf ah data export -q [--json] [-r ] [-a ] [-o ] [-p] [--output-dir ]
[--prefix ]

FLAGS
-a, --api-version= API version to use if different from the default
-o, --target-org= Login username or alias for the target org
-p, --progress Report Command Progress
-q, --query=Select ... from ... (required) Query to Extract Data
-r, --root= [default: ./] Root Project Path
--output-dir= [default: ./export] Generated Files Output Path
--prefix= Files Prefix

GLOBAL FLAGS
--json Format output as json.

DESCRIPTION
Export Salesforce Data.

Command to export data from the selected org to work with data:import command.

EXAMPLES
Extract Accounts data with related contacts

$ sf ah data export -q "Select Id, Name, BillingNumber, (Select Id, Name, AccountId, Phone from Contacts) from ^
Account" --output-file "./export/accounts"

Extract Accounts data with Records Types

$ sf ah data export -q "Select Id, Name, BillingNumber, RecordType.DeveloperName from Account" --output-file ^
"./export/accounts"

FLAG DESCRIPTIONS
-a, --api-version= API version to use if different from the default

API version to use if different from the default

-o, --target-org= Login username or alias for the target org

Overrides your default org

-p, --progress Report Command Progress

Option to report the command progress (into the selected format) or show a spinner loader

-q, --query=Select ... from ... Query to Extract Data

Query to extract data. You can use a simple query (Select [fields] from [object] [where] ...) or a complex query
(select [fields], [query], [query] from [object] [where] ...) for export data in tree format

-r, --root= Root Project Path

Path to project root. By default is your current folder

--output-dir= Generated Files Output Path

Path to save the generated output files. By default save result on /export

--prefix= Files Prefix

Prefix to add to the generated files
`

_See code: lib/commands/ah/data/export.ts_

sf ah data import

Import Salesforce Data.

`
USAGE
$ sf ah data import -q [--json] [-r ] [-a ] [-o ] [-p] [-f ] [-l ] [-s
]

FLAGS
-a, --api-version= API version to use if different from the default
-f, --file= File to Import.
-l, --limit= [default: 200] Record by Batch
-o, --target-org= Login username or alias for the target org
-p, --progress Report Command Progress
-q, --query=Select ... from ... (required) Query to Extract Data
-r, --root= [default: ./] Root Project Path
-s, --source-org= Source Org Username or Alias

GLOBAL FLAGS
--json Format output as json.

DESCRIPTION
Import Salesforce Data.

Command to import the data extracted with data:export command into the project connected org.

EXAMPLES
Import data from another org with username or alias "aliasOrg"

$ sf ah data import -o "aliasOrg" -q "Select Id, Name, BillingNumber, (Select Id, Name, AccountId, Phone from ^
Contacts) from Account",

Import data from extracted file with 50 records per batch

$ sf ah data import -f "./export/accounts/accounts-plan.json" -n 50

FLAG DESCRIPTIONS
-a, --api-version= API version to use if different from the default

API version to use if different from the default

-f, --file= File to Import.

Path to the exported file with data:export command to import into the auth org. Must be the -plan file.

-l, --limit= Record by Batch

Number of records to insert at one time. Max records per batch are 200. (200 by default)

-o, --target-org= Login username or alias for the target org

Overrides your default org

-p, --progress Report Command Progress

Option to report the command progress (into the selected format) or show a spinner loader

-q, --query=Select ... from ... Query to Extract Data

Query to extract data. You can use a simple query (Select [fields] from [object] [where] ...) or a complex query
(select [fields], [query], [query] from [object] [where] ...) for export data in tree format

-r, --root= Root Project Path

Path to project root. By default is your current folder

-s, --source-org= Source Org Username or Alias

Username or Alias to the source org for import data from the org, not from a file
`

_See code: lib/commands/ah/data/import.ts_

sf ah execute apex

Execute Anonymous Apex N Times.

`
USAGE
$ sf ah execute apex --file [--json] [-r ] [-o ] [-a ] [-i ] [-l -p]

FLAGS
-a, --api-version= API version to use if different from the default
-i, --iterations= [default: 1] Script execution number
-l, --print-log Print Log every execution
-o, --target-org= Login username or alias for the target org
-p, --progress Report Command Progress
-r, --root= [default: ./] Root Project Path
--file= (required) Script File Path

GLOBAL FLAGS
--json Format output as json.

DESCRIPTION
Execute Anonymous Apex N Times.

Command to execute an Anonymous Apex script from file against the auth org N times.

ALIASES
$ sf ah execute org apex
$ sf ah execute apex org
$ sf ah apex execute org
$ sf ah apex org execute
$ sf ah org execute apex
$ sf ah org apex execute
$ sf ah apex execute
$ sf ah execute apex

EXAMPLES
Execute a script 3 times

$ sf ah execute apex -f "path/to/script.apex" -i 3

Execute a script 10 times and print the execution log

$ sf ah execute apex -f "path/to/script.apex" --iterations 10 --print-log

FLAG DESCRIPTIONS
-a, --api-version= API version to use if different from the default

API version to use if different from the default

-i, --iterations= Script execution number

Option to select the scritp execution number. For example, 3 for execute the script 3 times

-l, --print-log Print Log every execution

Option to print the result log of every execution. Depends on --progress flag

-o, --target-org= Login username or alias for the target org

Overrides your default org

-p, --progress Report Command Progress

Option to report the command progress (into the selected format) or show a spinner loader

-r, --root= Root Project Path

Path to project root. By default is your current folder

--file= Script File Path

Path to the Anonymous Apex Script file
`

sf ah execute apex org

Execute Anonymous Apex N Times.

`
USAGE
$ sf ah execute apex org --file [--json] [-r ] [-o ] [-a ] [-i ] [-l -p]

FLAGS
-a, --api-version= API version to use if different from the default
-i, --iterations= [default: 1] Script execution number
-l, --print-log Print Log every execution
-o, --target-org= Login username or alias for the target org
-p, --progress Report Command Progress
-r, --root= [default: ./] Root Project Path
--file= (required) Script File Path

GLOBAL FLAGS
--json Format output as json.

DESCRIPTION
Execute Anonymous Apex N Times.

Command to execute an Anonymous Apex script from file against the auth org N times.

ALIASES
$ sf ah execute org apex
$ sf ah execute apex org
$ sf ah apex execute org
$ sf ah apex org execute
$ sf ah org execute apex
$ sf ah org apex execute
$ sf ah apex execute
$ sf ah execute apex

EXAMPLES
Execute a script 3 times

$ sf ah execute apex org -f "path/to/script.apex" -i 3

Execute a script 10 times and print the execution log

$ sf ah execute apex org -f "path/to/script.apex" --iterations 10 --print-log

FLAG DESCRIPTIONS
-a, --api-version= API version to use if different from the default

API version to use if different from the default

-i, --iterations= Script execution number

Option to select the scritp execution number. For example, 3 for execute the script 3 times

-l, --print-log Print Log every execution

Option to print the result log of every execution. Depends on --progress flag

-o, --target-org= Login username or alias for the target org

Overrides your default org

-p, --progress Report Command Progress

Option to report the command progress (into the selected format) or show a spinner loader

-r, --root= Root Project Path

Path to project root. By default is your current folder

--file= Script File Path

Path to the Anonymous Apex Script file
`

sf ah execute org apex

Execute Anonymous Apex N Times.

`
USAGE
$ sf ah execute org apex --file [--json] [-r ] [-o ] [-a ] [-i ] [-l -p]

FLAGS
-a, --api-version= API version to use if different from the default
-i, --iterations= [default: 1] Script execution number
-l, --print-log Print Log every execution
-o, --target-org= Login username or alias for the target org
-p, --progress Report Command Progress
-r, --root= [default: ./] Root Project Path
--file= (required) Script File Path

GLOBAL FLAGS
--json Format output as json.

DESCRIPTION
Execute Anonymous Apex N Times.

Command to execute an Anonymous Apex script from file against the auth org N times.

ALIASES
$ sf ah execute org apex
$ sf ah execute apex org
$ sf ah apex execute org
$ sf ah apex org execute
$ sf ah org execute apex
$ sf ah org apex execute
$ sf ah apex execute
$ sf ah execute apex

EXAMPLES
Execute a script 3 times

$ sf ah execute org apex -f "path/to/script.apex" -i 3

Execute a script 10 times and print the execution log

$ sf ah execute org apex -f "path/to/script.apex" --iterations 10 --print-log

FLAG DESCRIPTIONS
-a, --api-version= API version to use if different from the default

API version to use if different from the default

-i, --iterations= Script execution number

Option to select the scritp execution number. For example, 3 for execute the script 3 times

-l, --print-log Print Log every execution

Option to print the result log of every execution. Depends on --progress flag

-o, --target-org= Login username or alias for the target org

Overrides your default org

-p, --progress Report Command Progress

Option to report the command progress (into the selected format) or show a spinner loader

-r, --root= Root Project Path

Path to project root. By default is your current folder

--file= Script File Path

Path to the Anonymous Apex Script file
`

sf ah get org permissions

Get All Available User Permissions

`
USAGE
$ sf ah get org permissions [--json] [-r ] [-o ] [-a ] [-p] [--output-file ] [--csv]

FLAGS
-a, --api-version= API version to use if different from the default
-o, --target-org= Login username or alias for the target org
-p, --progress Report Command Progress
-r, --root= [default: ./] Root Project Path
--csv Show Result as CSV.
--output-file= Output file

GLOBAL FLAGS
--json Format output as json.

DESCRIPTION
Get All Available User Permissions

Command to get all available User permisions in your org

ALIASES
$ sf ah org permissions get
$ sf ah org get permissions
$ sf ah get org permissions
$ sf ah get permissions org
$ sf ah permissions org get
$ sf ah permissions get org

EXAMPLES
Get all available User permisions in your org and show the result as JSON

$ sf ah get org permissions --json

Get all available User permisions in your org and show the result as Table

$ sf ah get org permissions

Get all available User permisions in your org and save output as JSON

$ sf ah get org permissions --output-file "path/to/the/output/permissions.json" --json

Get all available User permisions in your org and save output as CSV

$ sf ah get org permissions --output-file "path/to/the/output/permissions.json" --csv

FLAG DESCRIPTIONS
-a, --api-version= API version to use if different from the default

API version to use if different from the default

-o, --target-org= Login username or alias for the target org

Overrides your default org

-p, --progress Report Command Progress

Option to report the command progress (into the selected format) or show a spinner loader

-r, --root= Root Project Path

Path to project root. By default is your current folder

--csv Show Result as CSV.

Option to show the result as CSV instead a table if not select --json flag

--output-file= Output file

Path to file for redirect the output
`

sf ah get permissions org

Get All Available User Permissions

`
USAGE
$ sf ah get permissions org [--json] [-r ] [-o ] [-a ] [-p] [--output-file ] [--csv]

FLAGS
-a, --api-version= API version to use if different from the default
-o, --target-org= Login username or alias for the target org
-p, --progress Report Command Progress
-r, --root= [default: ./] Root Project Path
--csv Show Result as CSV.
--output-file= Output file

GLOBAL FLAGS
--json Format output as json.

DESCRIPTION
Get All Available User Permissions

Command to get all available User permisions in your org

ALIASES
$ sf ah org permissions get
$ sf ah org get permissions
$ sf ah get org permissions
$ sf ah get permissions org
$ sf ah permissions org get
$ sf ah permissions get org

EXAMPLES
Get all available User permisions in your org and show the result as JSON

$ sf ah get permissions org --json

Get all available User permisions in your org and show the result as Table

$ sf ah get permissions org

Get all available User permisions in your org and save output as JSON

$ sf ah get permissions org --output-file "path/to/the/output/permissions.json" --json

Get all available User permisions in your org and save output as CSV

$ sf ah get permissions org --output-file "path/to/the/output/permissions.json" --csv

FLAG DESCRIPTIONS
-a, --api-version= API version to use if different from the default

API version to use if different from the default

-o, --target-org= Login username or alias for the target org

Overrides your default org

-p, --progress Report Command Progress

Option to report the command progress (into the selected format) or show a spinner loader

-r, --root= Root Project Path

Path to project root. By default is your current folder

--csv Show Result as CSV.

Option to show the result as CSV instead a table if not select --json flag

--output-file= Output file

Path to file for redirect the output
`

sf ah git tests extract

Extract Tests data from commits.

`
USAGE
$ sf ah git tests extract -s [--json] [-r ] [-a ] [--output-file ] [-t ]
[--start-tag ] [--end-tag ]

FLAGS
-a, --api-version= API version to use if different from the default
-r, --root= [default: ./] Root Project Path
-s, --source= (required) Source Branch, Commit or Tag.
-t, --target= Target Branch, Commit or Tag.
--end-tag= [default: --TESTS END--] End Tag to extract test Classes
--output-file= [default: ./export] Output file
--start-tag= [default: --TESTS START--] Start Tag to extract test Classes

GLOBAL FLAGS
--json Format output as json.

DESCRIPTION
Extract Tests data from commits.

Command to extract all test classes from commits messages from GIT differences between branches, commits or tags

EXAMPLES
Extracting tests data from differences between branchX and main branches

$ sf ah git tests extract -s branchX -t main

Extracting tests data from differences between branchX and main branches with json output

$ sf ah git tests extract -s branchX -t main --json

Extracting tests data from differences between branchX and main branches with custom start and end tag

$ sf ah git tests extract -s branchX -t main --start-tag \"MyCustom Test Start Tag\" --end-tag \"MyCustom Test ^
End Tag\" --json

FLAG DESCRIPTIONS
-a, --api-version= API version to use if different from the default

API version to use if different from the default

-r, --root= Root Project Path

Path to project root. By default is your current folder

-s, --source= Source Branch, Commit or Tag.

Source branch, commit, tag... to extract test classes from commit messages.

-t, --target= Target Branch, Commit or Tag.

Target branch, commit, tag... to extract test classes from commit messages.

--end-tag= End Tag to extract test Classes

End Tag for Test Classes names on git commit message (default: --TESTS END--)

--output-file= Output file

Path to file for redirect the output

--start-tag= Start Tag to extract test Classes

Start Tag for Test Classes names on git commit message. (default: --TESTS START--)
`

_See code: lib/commands/ah/git/tests/extract.ts_

sf ah local retrieve special

Summary of a command.

`
USAGE
$ sf ah local retrieve special [--json] [-r ] [-a ] [-p] [--all | -t ] [-i ] [--download-all]
[-c] [--sort-order simpleFirst|complexFirst|alphabetAsc|alphabetDesc]

FLAGS
-a, --api-version= API version to use if different from the default
-c, --compress Compress modified XML Files
-i, --include-org= Include Org Data
-p, --progress Report Command Progress
-r, --root= [default: ./] Root Project Path
-t, --type= Retrieve Specifics Metadata Types.
--all Retrieve all.
--download-all Download from All Namespaces
--sort-order= [default: simpleFirst] Sort order for XML Files compression


GLOBAL FLAGS
--json Format output as json.

DESCRIPTION
Summary of a command.

More information about a command. Don't repeat the summary.

ALIASES
$ sf ah local special retrieve
$ sf ah special local retrieve
$ sf ah local retrieve special

EXAMPLES
Retrieve all special types with XML Compression and including org data

$ sf ah local retrieve special --all -c -i

Retrieve specific metadata types. Retrive all Profiles, Two Permission Sets (Perm1, Perm2) and Some Record Types
(All Case RecordTypes and RTName Record Type from Account)

$ sf ah local retrieve special -t "Profile, PermissionSet:Perm1, PermissionSet:Perm2, RecordType:Case, ^
RecordType:Account:RtName"

FLAG DESCRIPTIONS
-a, --api-version= API version to use if different from the default

API version to use if different from the default

-c, --compress Compress modified XML Files

Add this option to compress modified files by retrieve operation

-i, --include-org= Include Org Data

With this option, you can retrieve the data from org, but only retrieve the types that you have in your local, in
other words, update local data with your org data

-p, --progress Report Command Progress

Option to report the command progress (into the selected format) or show a spinner loader

-r, --root= Root Project Path

Path to project root. By default is your current folder

-t, --type= Retrieve Specifics Metadata Types.

Retrieve specifics metadata types. You can choose one or a comma separated list of elements. Also you can choose
retrieve a specific profile, object o record type. Schema -> "Type1" or "Type1,Type2" or "Type1:Object1,
Type1:Object2" or "Type1:Object1:Item1" for example: "Profile, PermissinSet" to retrieve all profiles and permission
sets. "Profile:Admin" to retrieve the admin profile. "RecordType:Account:RecordType1" to retrieve the RecordType1
for the object Account or "RecordType:Account" to retrieve all Record Types for Account

--all Retrieve all.

Retrieve all supported Metadata Types (Profile,PermissionSet,Translations,RecordType,CustomObject)

--download-all Download from All Namespaces

Option to download all Metadata Types from any Namespaces (including managed packages). If this options is not
selected, only download and retrieve data from your org namespace

--sort-order=simpleFirst|complexFirst|alphabetAsc|alphabetDesc Sort order for XML Files compression

Sort order for the XML elements when compress XML files. By default, the elements are sorted with simple XML
elements first.
`

sf ah local special retrieve

Summary of a command.

`
USAGE
$ sf ah local special retrieve [--json] [-r ] [-a ] [-p] [--all | -t ] [-i ] [--download-all]
[-c] [--sort-order simpleFirst|complexFirst|alphabetAsc|alphabetDesc]

FLAGS
-a, --api-version= API version to use if different from the default
-c, --compress Compress modified XML Files
-i, --include-org= Include Org Data
-p, --progress Report Command Progress
-r, --root= [default: ./] Root Project Path
-t, --type= Retrieve Specifics Metadata Types.
--all Retrieve all.
--download-all Download from All Namespaces
--sort-order= [default: simpleFirst] Sort order for XML Files compression


GLOBAL FLAGS
--json Format output as json.

DESCRIPTION
Summary of a command.

More information about a command. Don't repeat the summary.

ALIASES
$ sf ah local special retrieve
$ sf ah special local retrieve
$ sf ah local retrieve special

EXAMPLES
Retrieve all special types with XML Compression and including org data

$ sf ah local special retrieve --all -c -i

Retrieve specific metadata types. Retrive all Profiles, Two Permission Sets (Perm1, Perm2) and Some Record Types
(All Case RecordTypes and RTName Record Type from Account)

$ sf ah local special retrieve -t "Profile, PermissionSet:Perm1, PermissionSet:Perm2, RecordType:Case, ^
RecordType:Account:RtName"

FLAG DESCRIPTIONS
-a, --api-version= API version to use if different from the default

API version to use if different from the default

-c, --compress Compress modified XML Files

Add this option to compress modified files by retrieve operation

-i, --include-org= Include Org Data

With this option, you can retrieve the data from org, but only retrieve the types that you have in your local, in
other words, update local data with your org data

-p, --progress Report Command Progress

Option to report the command progress (into the selected format) or show a spinner loader

-r, --root= Root Project Path

Path to project root. By default is your current folder

-t, --type= Retrieve Specifics Metadata Types.

Retrieve specifics metadata types. You can choose one or a comma separated list of elements. Also you can choose
retrieve a specific profile, object o record type. Schema -> "Type1" or "Type1,Type2" or "Type1:Object1,
Type1:Object2" or "Type1:Object1:Item1" for example: "Profile, PermissinSet" to retrieve all profiles and permission
sets. "Profile:Admin" to retrieve the admin profile. "RecordType:Account:RecordType1" to retrieve the RecordType1
for the object Account or "RecordType:Account" to retrieve all Record Types for Account

--all Retrieve all.

Retrieve all supported Metadata Types (Profile,PermissionSet,Translations,RecordType,CustomObject)

--download-all Download from All Namespaces

Option to download all Metadata Types from any Namespaces (including managed packages). If this options is not
selected, only download and retrieve data from your org namespace

--sort-order=simpleFirst|complexFirst|alphabetAsc|alphabetDesc Sort order for XML Files compression

Sort order for the XML elements when compress XML files. By default, the elements are sorted with simple XML
elements first.
`

sf ah logs clean

Summary of a command.

`
USAGE
$ sf ah logs clean -o [--json] [-a ]

FLAGS
-a, --api-version= API version to use if different from the default
-o, --target-org= (required) Login username or alias for the target org

GLOBAL FLAGS
--json Format output as json.

DESCRIPTION
Summary of a command.

More information about a command. Don't repeat the summary.

EXAMPLES
$ sf ah logs clean

FLAG DESCRIPTIONS
-a, --api-version= API version to use if different from the default

API version to use if different from the default

-o, --target-org= Login username or alias for the target org

Overrides your default org
`

_See code: lib/commands/ah/logs/clean.ts_

sf ah metadata compare

Compare Metadata Types and Objects between two orgs or between your local project and your auth org

`
USAGE
$ sf ah metadata compare -o [--json] [-r ] [-s ] [-a ] [-p] [--output-file ]
[--csv]

FLAGS
-a, --api-version= API version to use if different from the default
-o, --target-org= (required) Target Org to Compare.
-p, --progress Report Command Progress
-r, --root= [default: ./] Root Project Path
-s, --source-org= Source Org to compare.
--csv Show the result as CSV
--output-file= Output file

GLOBAL FLAGS
--json Format output as json.

DESCRIPTION
Compare Metadata Types and Objects between two orgs or between your local project and your auth org

Command to compare your local project with your auth org for get the differences. The result are the metadata types
and objects that you have in your org, but don't have in your local project. Also can compare between two different
orgs and return the metadata that exists on target org but not exists on source org

ALIASES
$ sf ah metadata compare
$ sf ah compare metadata
$ sf ah org compare
$ sf ah compare org

EXAMPLES
Compare Metadata Types and Objects between your local project and your auth org

$ sf ah metadata compare -o test.username@salesforceOrg.com.qa

Compare Metadata Types and Objects between two orgs

$ sf ah metadata compare -s test.username@salesforceOrg.com.uat -o test.username@salesforceOrg.com.qa

Compare Metadata Types and Objects between your local project and your auth org and show the result as CSV

$ sf ah metadata compare -t test.username@salesforceOrg.com.qa --csv

Compare Metadata Types and Objects between your local project and your auth org and show the result as JSON

$ sf ah metadata compare -t test.username@salesforceOrg.com.qa --json

FLAG DESCRIPTIONS
-a, --api-version= API version to use if different from the default

API version to use if different from the default

-o, --target-org= Target Org to Compare.

Target Salesforce org to compare.

-p, --progress Report Command Progress

Option to report the command progress (into the selected format) or show a spinner loader

-r, --root= Root Project Path

Path to project root. By default is your current folder

-s, --source-org= Source Org to compare.

Source Salesforce org to compare. If you choose source, --root will be ignored. If you not choose source, the
command will compare your local project with your auth org

--csv Show the result as CSV

Option to show the result as CSV instead a table if not select --json flag

--output-file= Output file

Path to file for redirect the output
`

sf ah metadata local compress

Compress XML Metadata Files.

`
USAGE
$ sf ah metadata local compress [--json] [-r ] [--all | -f | -d ] [--sort-order
simpleFirst|complexFirst|alphabetAsc|alphabetDesc]

FLAGS
-d, --directory=... Compress XML Files from specific directory
-f, --file=... Compress XML Files from specific directory
-r, --root= [default: ./] Root Project Path
--all Compress All Project Files
--sort-order= [default: simpleFirst] Sort order for XML Files compression


GLOBAL FLAGS
--json Format output as json.

DESCRIPTION
Compress XML Metadata Files.

Compress XML Metadata Files for best conflict handling with SVC systems. Works with relative or absolute paths.

ALIASES
$ sf ah compress
$ sf ah xml compress
$ sf ah compress xml

EXAMPLES
Compress all project XML Files

$ sf ah metadata local compress -a

Compress all XML Files from objects folder (and subfolders)

$ sf ah metadata local compress -d force-app/main/default/objects --json

Compress all XML Files from objects folder (and subfolders) and applications folder

$ sf ah metadata local compress -d "force-app/main/default/objects" -d "force-app/main/default/applications"

Compress all XML Files from objects folder (and subfolders) and applications folder

$ sf ah metadata local compress -d "force-app/main/default/objects, force-app/main/default/applications"

Compress specific XML File with progress report

$ sf ah metadata local compress -f "force-app/main/default/objects/Account/Account.object-meta-xml" -p

Compress specific XML Files with JSON output

$ sf ah metadata local compress -f "force-app/main/default/objects/Account/Account.object-meta-xml" -f ^
"force-app/main/default/objects/Case/Case.object-meta-xml" --json

Compress specific XML Files with JSON output

$ sf ah metadata local compress -f "force-app/main/default/objects/Account/Account.object-meta-xml, ^
force-app/main/default/objects/Case/Case.object-meta-xml" --json

FLAG DESCRIPTIONS
-d, --directory=... Compress XML Files from specific directory

Compress XML Files from specific directory (and subfolders). This options does not take effect if you choose
compress all.

-f, --file=... Compress XML Files from specific directory

Compress XML Files from specific directory (and subfolders). This options does not take effect if you choose
compress all.

-r, --root= Root Project Path

Path to project root. By default is your current folder

--all Compress All Project Files

Compress all XML files with support compression in your project.

--sort-order=simpleFirst|complexFirst|alphabetAsc|alphabetDesc Sort order for XML Files compression

Sort order for the XML elements when compress XML files. By default, the elements are sorted with simple XML
elements first.
`

_See code: lib/commands/ah/metadata/local/compress.ts_

sf ah metadata local describe

Describe Local Metadata Types.

`
USAGE
$ sf ah metadata local describe [--json] [-r ] [-a ] [-p] [--all | -t ] [-g] [--output-file ]
[--csv]

FLAGS
-a, --api-version= API version to use if different from the default
-g, --group Group global Quick Actions into GlobalActions.
-p, --progress Report Command Progress
-r, --root= [default: ./] Root Project Path
-t, --type=... Describe the specified metadata types.
--all Describe all metadata types.
--csv Show result as CSV.
--output-file= Output file

GLOBAL FLAGS
--json Format output as json.

DESCRIPTION
Describe Local Metadata Types.

Command to describe all or specific Metadata Types like Custom Objects, Custom Fields, Apex Classes... that you have
in your local project.

EXAMPLES
Describe all metadata types, showing progress and show result as CSV and save output as CSV

$ sf ah metadata local describe -a -p --output-file "path/to/the/output/file.csv" --csv

Describe all metadata types, showing progress and show result as JSON and save output as JSON

$ sf ah metadata local describe -a -p --output-file "path/to/the/output/file.json" --json

Describe CustomObject, CustomField, Profile and ValidationRule metadata types, showing progress and result as table

$ sf ah metadata local describe -t "CustomObject, CustomField, Profile, ValidationRule" -p

Describe CustomObject, CustomField, Profile and ValidationRule metadata types, showing progress and result as table

$ sf ah metadata local describe -t "CustomObject" -t "CustomField" -t "Profile -t "ValidationRule" -p

Describe CustomObject and CustomField metadata types, showing result as JSON

$ sf ah metadata local describe -t "CustomObject, CustomField" --json

Describe CustomObject and CustomField metadata types, showing result as JSON

$ sf ah metadata local describe -t "CustomObject" -t "CustomField" --json

FLAG DESCRIPTIONS
-a, --api-version= API version to use if different from the default

API version to use if different from the default

-g, --group Group global Quick Actions into GlobalActions.

Option to group global Quick Actions into GlobalActions group, false to list as object and item.

-p, --progress Report Command Progress

Option to report the command progress (into the selected format) or show a spinner loader

-r, --root= Root Project Path

Path to project root. By default is your current folder

-t, --type=... Describe the specified metadata types.

Describe the specified metadata types. You can select a single metadata or a list separated by commas. This option
does not take effect if you choose describe all.

--all Describe all metadata types.

Describe all metadata types stored in your local project.

--csv Show result as CSV.

Option to show the result as CSV instead a table if not select --json flag

--output-file= Output file

Path to file for redirect the output
`

_See code: lib/commands/ah/metadata/local/describe.ts_

sf ah metadata local ignore

Ignore Metadata from your project

``
USAGE
$ sf ah metadata local ignore [--json] [-r ] [-p] [--all | -t ] [--file ] [-c] [--sort-order
simpleFirst|complexFirst|alphabetAsc|alphabetDesc]

FLAGS
-c, --compress Compress modified files.
-p, --progress Report Command Progress
-r, --root= [default: ./] Root Project Path
-t, --type= Ignore specific Metadata Types.
--all Ignore All Metadata types on file.
--file= [default: ./.ahignore.json] Path to the ignore file.
--sort-order= [default: simpleFirst] Sort order for XML Files compression

GLOBAL FLAGS
--json Format output as json.

DESCRIPTION
Ignore Metadata from your project

Command for ignore metadata from your project. Use .ahignore.json file for perform this operation. This command will
be delete the ignored metadata from your project folder

EXAMPLES
Ignore All Metadata Types on ignore file and compress modified files

$ sf ah metadata local ignore -a -c --json

Ignore Specific Metadata Types on ignore file with different ignore file (not default ignore file from project)

$ sf ah metadata local ignore -t "CustomApplication, Profile, CustomLabels" -i ^
"Path/to/the/file/.myignoreFile.json" -p

FLAG DESCRIPTIONS
-c, --compress Compress modified files.

Add this option to compress modified files by ignore operation.

-p, --progress Report Command Progress

Option to report the command progress (into the selected format) or show a spinner loader

-r, --root= Root Project Path

Path to project root. By default is your current folder

-t, --type= Ignore specific Metadata Types.

Ignore the specified metadata types according to the ignore file. You can select a sigle or a list separated by
commas. This option