Omega DX

==============

Utilities for development, audit and CI/CD by Omega CRM

Development

==============

Clone the repo

git clone ...

Install dependencies

npm i / yarn install

If using yarn, ensure version 1.22.x is being used

Link the repo as plugin

If you have installed the pulgin in its relase version, firts uninstall to avoid any issues

# To uninstall the plugin
sf plugins uninstall @omegacrm
# From repo folder
sf plugins link .

Start compilation in watch mode

npm run build:watch

Debug the plugin

Just place some breakpoint in a TS file, open a new Javascript Debug Terminal on VSCode, and run some sf omega commmand

Documentation

==============

Omega DX
Development
To uninstall the plugin
From repo folder
Documentation

$ sf plugins install @omegacrm/omega-dx
$ sf omega COMMAND
running command...
$ sf (--version)
@omegacrm/omega-dx/1.0.0 linux-x64 node-v18.16.0
$ sf --help [COMMAND]
USAGE
  $ sf omega COMMAND
...

sf omega doc erd
sf omega:audit:automation
sf omega:audit:deadcode
sf omega:audit:dependencies
sf omega:audit:doctor
sf omega:audit:emptyobjects
sf omega:audit:guest
sf omega:audit:namingconventions
sf omega:audit:object
sf omega:confluence:export
sf omega:confluence:update
sf omega:data:fakedata
sf omega:data:loader
sf omega:deploy
sf omega:doc:apexdoc
sf omega:doc:packages
sf omega:doc:uml
sf omega:lwc:oss:convert
sf omega:lwc:oss:create
sf omega:manifest:diff
sf omega:manifest:files
sf omega:manifest:generate
sf omega:manifest:mdtfromobj
sf omega:manifest:test
sf omega:project:setup
sf omega:project:types
sf omega:report:log
sf omega:report:permission

`sf omega doc erd`

Generates an UML class diagram out of your Apex classes

USAGE
  $ sf omega doc erd -x <value> -o <value> [--json] [--flags-dir <value>] [-c] [-f <value>] [-k class|erd...]
    [--no-details]

FLAGS
  -c, --compile             If the classes should be compiled before querying their SymbolTable.
  -f, --format=<value>      [default: svg] The file where the file will be created. Defaults to SVG
  -k, --kind=<option>...    [default: class] Type of diagram to generate (class, erd, etc...)
                            <options: class|erd>
  -o, --target-org=<value>  (required) Username or alias of the target org. Not required if the `target-org`
                            configuration variable is already set.
  -x, --output=<value>      (required) The path where the file will be created
      --no-details          Skip fields, class members etc. Only show top parent boxes

                            Summary of the flag

GLOBAL FLAGS
  --flags-dir=<value>  Import flag values from a directory.
  --json               Format output as json.

DESCRIPTION
  Generates an UML class diagram out of your Apex classes

  Generates an UML class diagram out of your Apex classes

ALIASES
  $ sf omega doc erd

EXAMPLES
  $ sf omega:doc:uml -h
  $ sf omega:doc:uml --all
  $ sf omega:doc:uml -c

`sf omega:audit:automation`

Reports on all automation processes by Object/entity to see a global overview and recommendations on how the org is being automated

USAGE
  $ sf omega:audit:automation -o <value> [--json] [--flags-dir <value>] [--inactives] [--no-list] [--exclude-managed]
    [--show-flow-details] [--show-modified-by] [--show-flows-as-table] [-s <value>] [-x <value>] [-f html|json]
    [--api-version <value>]

FLAGS
  -f, --format=<option>      [default: json] File output format (html, json, xml...)
                             <options: html|json>
  -o, --target-org=<value>   (required) Username or alias of the target org. Not required if the `target-org`
                             configuration variable is already set.
  -s, --skip=<value>         Metadatatypes to skip separated by commas
  -x, --output=<value>       Output file path and name
      --api-version=<value>  Override the api version used for api requests made by this command
      --exclude-managed      Exclude managed package objects
      --inactives            Report on inactives
      --no-list              Do not list elements
      --show-flow-details    Whether flow details should be displayes
      --show-flows-as-table  Whether flow data should be displayed on a subtable or not
      --show-modified-by     Whether elements modified by name should be displayed

GLOBAL FLAGS
  --flags-dir=<value>  Import flag values from a directory.
  --json               Format output as json.

DESCRIPTION
  Reports on all automation processes by Object/entity to see a global overview and recommendations on how the org is
  being automated

  Reports on all automation processes by Object/entity to see a global overview and recommendations on how the org is
  being automated

EXAMPLES
  $ sf omega audit deadcode
  $ sf omega audit deadcode -c --filter=""
  $ sf omega audit deadcode --basedir="/my/project/path" -p "package1,package2"
  $ sf omega audit deadcode --basedir="/my/project/path" --all

`sf omega:audit:deadcode`

Find all potential Apex code not being used

USAGE
  $ sf omega:audit:deadcode -o <value> [--json] [--flags-dir <value>] [-a] [--exclude-refs-from-tests] [--filter <value>]
    [-x <value>] [-f <value>] [-c] [--api-version <value>]

FLAGS
  -a, --all                      Inpect all classes in org
  -c, --compile                  If the classes should be compiled before querying their SymbolTable
  -f, --format=<value>           [default: json] Format of the file
  -o, --target-org=<value>       (required) Username or alias of the target org. Not required if the `target-org`
                                 configuration variable is already set.
  -x, --output=<value>           Where to store the result as JSON
      --api-version=<value>      Override the api version used for api requests made by this command
      --exclude-refs-from-tests  If the references from test classes should not be accounted
      --filter=<value>           Regex-valid string representation for filtering out classes when inspecting

GLOBAL FLAGS
  --flags-dir=<value>  Import flag values from a directory.
  --json               Format output as json.

DESCRIPTION
  Find all potential Apex code not being used

  List all potential Apex code not being used

EXAMPLES
  $ sf omega audit deadcode
  $ sf omega audit deadcode -c --filter=""
  $ sf omega audit deadcode --basedir="/my/project/path" -p "package1,package2"
  $ sf omega audit deadcode --basedir="/my/project/path" --all

`sf omega:audit:dependencies`

Search metadata components not being referenced in anywhere (dont having an entry in MetadataDependency API)

USAGE
  $ sf omega:audit:dependencies -o <value> -t <value>... [--json] [--flags-dir <value>] [-a] [-f json] [-x <value>]

FLAGS
  -a, --only-orphans        Report only thos components not being reference anywhere
  -f, --format=<option>     [default: json] File output format (html, json, xml...)
                            <options: json>
  -o, --target-org=<value>  (required) Username or alias of the target org. Not required if the `target-org`
                            configuration variable is already set.
  -t, --type=<value>...     (required) Metadata type name to search in
  -x, --output=<value>      [default: ./] Directory where the output will be stored

GLOBAL FLAGS
  --flags-dir=<value>  Import flag values from a directory.
  --json               Format output as json.

DESCRIPTION
  Search metadata components not being referenced in anywhere (dont having an entry in MetadataDependency API)

  Search metadata components not being referenced in anywhere (dont having an entry in MetadataDependency API)

EXAMPLES
  $ sf omega:audit:dependencies -h
  $ sf omega:audit:dependencies -t ApexClass
  $ sf omega audit dependencies -t Layout -x ./audit -f json

`sf omega:audit:doctor`

Runs compliance rules against a project or an org

USAGE
  $ sf omega:audit:doctor -o <value> [--json] [--flags-dir <value>] [-a] [-m <value>...] [-r <value>] [-c <value>...]
    [--dump]

FLAGS
  -a, --all                       Inspect all metadata in org. This will fire a retrieve operation. It needs a valid
                                  'target-org'
  -c, --category=<value>...       Only execute rules of fiven categories. If blank, all categories will be executed
  -m, --metadata-type=<value>...  Only execute rules for give metadata types
  -o, --target-org=<value>        (required) Username or alias of the target org. Not required if the `target-org`
                                  configuration variable is already set.
  -r, --ruleset=<value>           Custom ruleset to apply
      --dump                      Export full rule catalog to use

GLOBAL FLAGS
  --flags-dir=<value>  Import flag values from a directory.
  --json               Format output as json.

DESCRIPTION
  Runs compliance rules against a project or an org

  Runs compliance rules against a project or an org

EXAMPLES
  $ sf omega audit doctor -h
  $ sf omega audit doctor
  $ sf omega audit doctor -m Flow -m CustomField
  $ sf omega audit doctor -c Best practices
  $ sf omega audit doctor -c "Best practices" -c Documentation -m CustomField

`sf omega:audit:emptyobjects`

Find objects, custom settings and custom metadata types without records created

USAGE
  $ sf omega:audit:emptyobjects -o <value> [--json] [--flags-dir <value>] [-c]

FLAGS
  -c, --objects             Comma-separated objects
  -o, --target-org=<value>  (required) Username or alias of the target org. Not required if the `target-org`
                            configuration variable is already set.

GLOBAL FLAGS
  --flags-dir=<value>  Import flag values from a directory.
  --json               Format output as json.

DESCRIPTION
  Find objects, custom settings and custom metadata types without records created

  Find objects, custom settings and custom metadata types without records created

EXAMPLES
  $ sf omega audit emptyobjects -h
  $ sf omega audit emptyobjects --all
  $ sf omega audit emptyobjects -o

`sf omega:audit:guest`

Audit guest user access on communities

USAGE
  $ sf omega:audit:guest [--json] [--flags-dir <value>] [-o <value>] [-u <value>] [-f json] [-x <value>] [--api-version
    <value>]

FLAGS
  -f, --format=<option>        [default: json] File output format (html, json, xml...)
                               <options: json>
  -o, --target-org=<value>     Username or alias of the target org.
  -u, --community-url=<value>  Community public URL to exploit. If set only this community will be analyzed
  -x, --output=<value>         [default: ./] Directory where the output will be stored
      --api-version=<value>    Override the api version used for api requests made by this command

GLOBAL FLAGS
  --flags-dir=<value>  Import flag values from a directory.
  --json               Format output as json.

DESCRIPTION
  Audit guest user access on communities

  Perform simple Aura endpoint exploitations to find missconfigurations on Guest User

`sf omega:audit:namingconventions`

Search metadata names not following out naming conventions

USAGE
  $ sf omega:audit:namingconventions [--json] [--flags-dir <value>] [-o <value>] [-a]

FLAGS
  -a, --all                 Inpect all defined types
  -o, --target-org=<value>  Username or alias of the target org.

GLOBAL FLAGS
  --flags-dir=<value>  Import flag values from a directory.
  --json               Format output as json.

DESCRIPTION
  Search metadata names not following out naming conventions

  Search metadata names not following out naming conventions

EXAMPLES
  $ sf omega:audit:namingconventions -h
  $ sf omega:audit:namingconventions
  $ sf omega:audit:namingconventions -a

`sf omega:audit:object`

Audit an object and its values

USAGE
  $ sf omega:audit:object -o <value> [--json] [--flags-dir <value>] [-s <value>...] [-v] [-x <value>] [-d]

FLAGS
  -d, --duplicatereferences  If dependencies must have all the references
  -o, --target-org=<value>   (required) Username or alias of the target org. Not required if the `target-org`
                             configuration variable is already set.
  -s, --sobject=<value>...   [default: All objects] SObject to retrieve the data, it allows multiple objects.
  -v, --values               If values of the fields should be retrieved (Ex: picklist)
  -x, --output=<value>       [default: ObjectReport.xlsx] Where to store generated files

GLOBAL FLAGS
  --flags-dir=<value>  Import flag values from a directory.
  --json               Format output as json.

DESCRIPTION
  Audit an object and its values

  Extracts all fields from an object, their formulas, picklist values and where they are used

EXAMPLES
  $ sf omega audit object
  $ sf omega audit object -t Account

`sf omega:confluence:export`

Export a page from Confluence

USAGE
  $ sf omega:confluence:export -u <value> -t <value> -d <value> -p <value> -x <value> --format md|html -a [--json]
    [--flags-dir <value>]

FLAGS
  -a, --attachments       (required) wheter the attachments for the page should be downloaded
  -d, --domain=<value>    (required) [default: https://omegacrm.atlassian.net] confluence domain
  -p, --pageid=<value>    (required) confluence page id to update
  -t, --token=<value>     (required) app token fro the user on confluence
  -u, --username=<value>  (required) Confluence's username
  -x, --output=<value>    (required) file path where result will be stored
      --format=<option>   (required) [default: md] format of the file
                          <options: md|html>

GLOBAL FLAGS
  --flags-dir=<value>  Import flag values from a directory.
  --json               Format output as json.

DESCRIPTION
  Export a page from Confluence

  Export a page from Confluence given its page Id.

EXAMPLES
  $ sf omega:confluence:export export -d https://omegacrm.atlassian.net -u mlaso@omegacrmconsulting.com --token=MYTOKEN --pageid=3793879327 -o ./guides/test.md --attachments

`sf omega:confluence:update`

Export a page from Confluence

USAGE
  $ sf omega:confluence:update -u <value> -t <value> -d <value> -p <value> -f <value> [--json] [--flags-dir <value>]

FLAGS
  -d, --domain=<value>    (required) [default: https://omegacrm.atlassian.net] confluence domain
  -f, --file=<value>      (required) path of the file to upload to confluence
  -p, --pageid=<value>    (required) confluence page id to update
  -t, --token=<value>     (required) app token fro the user on confluence
  -u, --username=<value>  (required) Confluence's username

GLOBAL FLAGS
  --flags-dir=<value>  Import flag values from a directory.
  --json               Format output as json.

DESCRIPTION
  Export a page from Confluence

  Export a page from Confluence given its page Id.

EXAMPLES
  $ sf omega:confluence:update -d https://omegacrm.atlassian.net -u mlaso@omegacrmconsulting.com --token=MYTOKEN --pageid=3800858625 -f ./guides/mymarkdownpage.md

`sf omega:data:fakedata`

Create a JSON with fake data based

USAGE
  $ sf omega:data:fakedata -o <value> [--json] [--flags-dir <value>] [-s <value>] [--config <value>] [-f <value>]
    [--verbose]

FLAGS
  -f, --format=<value>      [default: json] The format to generate (json or csv). Defaults to json
  -o, --target-org=<value>  (required) Username or alias of the target org. Not required if the `target-org`
                            configuration variable is already set.
  -s, --object=<value>      The main object to generate data
      --config=<value>      The configuration file to apply. Required for tree formats
  --verbose

GLOBAL FLAGS
  --flags-dir=<value>  Import flag values from a directory.
  --json               Format output as json.

DESCRIPTION
  Create a JSON with fake data based

  Create a JSON with fake data based

EXAMPLES
  $ sf omega:data:fakedata -h
  $ sf omega:data:fakedata -t ApexClass

`sf omega:data:loader`

Load records to an org

USAGE
  $ sf omega:data:loader -o <value> [--json] [--flags-dir <value>] [-d <value>] [-f <value> -a
    create|update|upsert|delete -b <value>] [-c <value>] [-p <value>] [-n] [-e <value>] [-r <value>]

FLAGS
  -a, --action=<option>      action to perform
                             <options: create|update|upsert|delete>
  -b, --object=<value>       object to load
  -c, --chunksize=<value>    [default: 50] chunk size of the records to load (max: 200, min: 1)
  -d, --directory=<value>    loads all files in the directory to the org, the fields must be in format
                             {sobject}-{action}.csv (Example: Account-create.csv)
  -e, --externalid=<value>   external id field
  -f, --file=<value>         file to load
  -n, --allornone            all or none
  -o, --target-org=<value>   (required) org to load to
  -p, --promisesize=<value>  [default: 10] number of promises to run in parallel
  -r, --retries=<value>      [default: 5] number of retries

GLOBAL FLAGS
  --flags-dir=<value>  Import flag values from a directory.
  --json               Format output as json.

DESCRIPTION
  Load records to an org

  Use this command to load records from files or folders to an org.

EXAMPLES
  $ sf omega data loader --object Account --chunksize 50 --file ./data/Account.csv --promisesize 10 --action insert --extenalid ExternalId__c
  $ sf omega data loader --directory ./data/ --chunksize 50 --promisesize 10 -r 5

`sf omega:deploy`

Helps a user to deploy faster with different shortcuts

USAGE
  $ sf omega:deploy -o <value> [--json] [--flags-dir <value>] [-i <value>] [-w <value>...] [-s]

FLAGS
  -i, --interval=<value>     [default: 1] gets the files modified in the last n minutes and deploys them.
  -o, --target-org=<value>   (required) a flag that expects a username of an org that you have authorized
  -s, --casesensitive        If wildcard check should be case insensitive
  -w, --wildcard=<value>...  Combination of wildcards to detect files

GLOBAL FLAGS
  --flags-dir=<value>  Import flag values from a directory.
  --json               Format output as json.

DESCRIPTION
  Helps a user to deploy faster with different shortcuts

  Helps a user to deploy faster with different shortcuts

EXAMPLES
  $ sf omega deploy -i 10

`sf omega:doc:apexdoc`

Generates a SLDS-styled Apex documentation site

USAGE
  $ sf omega:doc:apexdoc -x <value> [--json] [--flags-dir <value>] [-g <value>] [-f html|markdown] [--nonav]
    [--visibility global|public|private...] [--includetests] [-m singlepage|multipage]

FLAGS
  -f, --format=<option>         [default: html] File format for the outputs
                                <options: html|markdown>
  -g, --defaultgroup=<value>    [default: Others] The default group for classes that dont belong to any group
  -m, --mode=<option>           [default: singlepage] How to generate the HTML files. "multipage" (a page for each
                                class) or "singlepage"
                                <options: singlepage|multipage>
  -x, --output=<value>          (required) The path where the file or files will be created
      --includetests            If test classes should be processed
      --nonav                   If the navigation should not be generated
      --visibility=<option>...  [default: global,public] Visibility of the classes and ckass members to render in the
                                document/s generated
                                <options: global|public|private>

GLOBAL FLAGS
  --flags-dir=<value>  Import flag values from a directory.
  --json               Format output as json.

DESCRIPTION
  Generates a SLDS-styled Apex documentation site

  Generates a SLDS-styled Apex documentation site

EXAMPLES
  $ sfdx omega:doc:apex -h
  $ sfdx omega:doc:apex --packages="default,mypackagename"
  $ sfdx omega:doc:apex -m singlepage --packages="default,mypackagename"

`sf omega:doc:packages`

Generates package documentation for your project

USAGE
  $ sf omega:doc:packages [--json] [--flags-dir <value>] [-c <value>] [-x <value>] [--basedir <value>]

FLAGS
  -c, --settingsfile=<value>  The path to the process config file
  -x, --outputpath=<value>    [default: ./doc] The path where the generated doc will be stored. Defaults to
                              "projectpath/doc"
      --basedir=<value>       If not in an SFDX project, the base dir of the project from where package names will be
                              resolved

GLOBAL FLAGS
  --flags-dir=<value>  Import flag values from a directory.
  --json               Format output as json.

DESCRIPTION
  Generates package documentation for your project

  Generates package documentation for your project

EXAMPLES
  $ sfdx omega:doc:packages -h

  $ sfdx omega:doc:packages -c ./mydocfg.js

FLAG DESCRIPTIONS
  --basedir=<value>  If not in an SFDX project, the base dir of the project from where package names will be resolved

    If not in an SFDX project, the base dir of the project from where package names will be resolved

`sf omega:doc:uml`

Generates an UML class diagram out of your Apex classes

USAGE
  $ sf omega:doc:uml -x <value> -o <value> [--json] [--flags-dir <value>] [-c] [-f <value>] [-k class|erd...]
    [--no-details]

FLAGS
  -c, --compile             If the classes should be compiled before querying their SymbolTable.
  -f, --format=<value>      [default: svg] The file where the file will be created. Defaults to SVG
  -k, --kind=<option>...    [default: class] Type of diagram to generate (class, erd, etc...)
                            <options: class|erd>
  -o, --target-org=<value>  (required) Username or alias of the target org. Not required if the `target-org`
                            configuration variable is already set.
  -x, --output=<value>      (required) The path where the file will be created
      --no-details          Skip fields, class members etc. Only show top parent boxes

                            Summary of the flag

GLOBAL FLAGS
  --flags-dir=<value>  Import flag values from a directory.
  --json               Format output as json.

DESCRIPTION
  Generates an UML class diagram out of your Apex classes

  Generates an UML class diagram out of your Apex classes

ALIASES
  $ sf omega doc erd

EXAMPLES
  $ sf omega:doc:uml -h
  $ sf omega:doc:uml --all
  $ sf omega:doc:uml -c

`sf omega:lwc:oss:convert`

Converts a LWC OSS to a Platform LWC

USAGE
  $ sf omega:lwc:oss:convert -s <value> -p <value> -x <value> [--json] [--flags-dir <value>] [-e <value>]

FLAGS
  -e, --exclude=<value>     Comma-separated module names to exclude form the process
  -p, --prefix=<value>      (required) The namespace used to replace. For example "om"
  -s, --sourcepath=<value>  (required) The path where the modules live
  -x, --output=<value>      (required) The folder path where the result will be generated

GLOBAL FLAGS
  --flags-dir=<value>  Import flag values from a directory.
  --json               Format output as json.

DESCRIPTION
  Converts a LWC OSS to a Platform LWC

  Converts a LWC OSS to a Platform LWC

`sf omega:lwc:oss:create`

Generates a new LWC OSS.

USAGE
  $ sf omega:lwc:oss:create -o <value> -s <value> [--json] [--flags-dir <value>]

FLAGS
  -o, --target-org=<value>  (required) Username or alias of the target org. Not required if the `target-org`
                            configuration variable is already set.
  -s, --sourcepath=<value>  (required) The path including the name where the LWC will be created

GLOBAL FLAGS
  --flags-dir=<value>  Import flag values from a directory.
  --json               Format output as json.

DESCRIPTION
  Generates a new LWC OSS.

  Generates a new LWC OSS.

EXAMPLES
  $ sfdx omega:lwc:oss:create -h

  $ sfdx omega:lwc:oss:create -s ./mycomponent

`sf omega:manifest:diff`

Generate a package/s from a GIT diff

USAGE
  $ sf omega:manifest:diff -f <value> -t <value> -x <value> [--json] [--flags-dir <value>] [-c] [-d <value>] [-z]
    [--api-version <value>]

FLAGS
  -c, --copy                 Copy the diff files to the output directory
  -d, --directory=<value>    [default: ./tmp/] Directory to copy the diff files to
  -f, --from=<value>         (required) Initial commit hash to run the diff
  -t, --to=<value>           (required) Final commit hash to run the diff
  -x, --output=<value>       (required) Where to store generated files
  -z, --destructive-changes  If we should generate destructive changes XML
      --api-version=<value>  Override the api version used for api requests made by this command

GLOBAL FLAGS
  --flags-dir=<value>  Import flag values from a directory.
  --json               Format output as json.

DESCRIPTION
  Generate a package/s from a GIT diff

  Generate a package/s from a GIT diff

EXAMPLES
  $ sfdx omega:diff -h
  

  $ sfdx  omega:diff -f a61283g537 -t u7ii8o9823 -o path/to/package/generated.xml

`sf omega:manifest:files`

Find similarities and differences between two manifest files

USAGE
  $ sf omega:manifest:files -x <value> -f <value>... [--json] [--flags-dir <value>] [-m unified|differences|similarities]
    [--api-version <value>]

FLAGS
  -f, --file=<value>...      (required) Path to the manifest file
  -m, --mode=<option>        [default: unified] The operation to perform
                             <options: unified|differences|similarities>
  -x, --output=<value>       (required) [default: output.xml] The path where the result will be generated
      --api-version=<value>  Override the api version used for api requests made by this command

GLOBAL FLAGS
  --flags-dir=<value>  Import flag values from a directory.
  --json               Format output as json.

DESCRIPTION
  Find similarities and differences between two manifest files

  Find similarities and differences between two manifest files

EXAMPLES
  $ sf omega manifest files -h
  $ sf omega manifest files -f manifest/package.xml -f manifest/package2.xml -x manifest/unified.xml
  $ sf omega manifest files -f manifest/package.xml -f manifest/package2.xml -x manifest/unified.xml --api-version 60.0
  $ sf omega manifest files -f manifest/package.xml -f manifest/package2.xml -m differences -x manifest/differences.xml
  $ sf omega manifest files -f manifest/package.xml -f manifest/package2.xml -m similarities -x manifest/similarities.xml

`sf omega:manifest:generate`

Create a Package.xml with the metadata chosen

USAGE
  $ sf omega:manifest:generate -o <value> [--json] [--flags-dir <value>] [-x <value>] [--exclude <value>] [--only <value>]
    [--childs] [--ignoreparents] [--retrieve] [-t <value>] [--nomanaged] [--nounmanaged] [--nomanagedcustoms]
    [--standardvalueset] [--verbose]

FLAGS
  -o, --target-org=<value>  (required) Username or alias of the target org. Not required if the `target-org`
                            configuration variable is already set.
  -t, --tmpdir=<value>      [default: ./tmp] Path to tmp dir where needed mdapi retrieves will be done. Defaults to
                            $PWD/tmp.
                            Will be deleted after the process completes
  -x, --output=<value>      [default: ./generatedManifest.xml] The path where the xml file will be created
      --childs              Set for extract any child metadata separately (ex: CustomField from CustomObject)
      --exclude=<value>     Comma-separated component types to exclude. Invalid types or types not existing in the org
                            will be ignored
      --ignoreparents       If --childs is set to true, set this to ignore the "parent" metadata type. (ex: Ignore
                            CustomObject if CustomField is processed)
      --nomanaged           If components from managed packages should be ignored
      --nomanagedcustoms    Do not process customizations in managed packaged components (ex: CustomFields in Managed
                            CustomObjects)
      --nounmanaged         If components from unmanaged packages should be ignored
      --only=<value>        Comma-separated component types to process exclusively. Invalid types or types not existing
                            in the org will be ignored
      --retrieve            Whether the type should be retrieved after listing
      --standardvalueset    If all the StandardValueSet should be added to the package
  --verbose

GLOBAL FLAGS
  --flags-dir=<value>  Import flag values from a directory.
  --json               Format output as json.

DESCRIPTION
  Create a Package.xml with the metadata chosen

  Create a Package.xml with the metadata chosen

EXAMPLES
  $ sf omega:manifest:generate -h
  $ sf omega:manifest:generate -o ./mycomponent
  $ sf omega:manifest:generate --nomanaged --nounmanaged --standardvalueset -o "./generatedPackage.xml" --exclude="Report,Dashboard"

`sf omega:manifest:mdtfromobj`

Create a Custom Metadata From an Object

USAGE
  $ sf omega:manifest:mdtfromobj -s <value> -o <value> [--json] [--flags-dir <value>] [-i <value>] [-d <value>] [-f <value>]
    [-p <value>] [-m <value>] [-k]

FLAGS
  -d, --outputdir=<value>         [default: force-app/main/default/customMetadata] The directory to store newly-created
                                  custom metadata record files
  -f, --filters=<value>           The criteria to filter the sobject separated by commas. Example: -f
                                  includeField,!notIncludeField,=exactField,!=notExactFiel
  -i, --inputdir=<value>          [default: force-app/main/default/objects] The directory to pull the custom metadata
                                  type definition from
  -k, --keepfiles                 Keep the files created
  -m, --manifestdir=<value>       [default: ./manifest/OmegaDX.xml] The directory to store the manifest file in
  -o, --target-org=<value>        (required) Username or alias of the target org. Not required if the `target-org`
                                  configuration variable is already set.
  -p, --packageoutputdir=<value>  [default: metadataOmegaDX.xml] The path of the package to deploy the custom metadata
                                  records in
  -s, --sobject=<value>           (required) The name of the sobject to create the records from

GLOBAL FLAGS
  --flags-dir=<value>  Import flag values from a directory.
  --json               Format output as json.

DESCRIPTION
  Create a Custom Metadata From an Object

  Create a Custom Metadata From an Object

EXAMPLES
  $ sf omega:project:mdtFromObj -h
  $ sf omega:project:mdtFromObj -i ./packages/tu_paquete/main/default/objects

`sf omega:manifest:test`

Get test classes from directory, project or manifest file

USAGE
  $ sf omega:manifest:test [--json] [--flags-dir <value>] [-x <value>] [-w <value>...] [-j <value>] [-i]

FLAGS
  -i, --case-insensitive     If wildcard check should be case insensitive
  -j, --join=<value>         [default:  -t ] Join pattern
  -w, --wildcard=<value>...  Combination of wildcards to detect Test files
  -x, --manifest=<value>     The manifest you want to check

GLOBAL FLAGS
  --flags-dir=<value>  Import flag values from a directory.
  --json               Format output as json.

DESCRIPTION
  Get test classes from directory, project or manifest file

  Get test classes from directory, project or manifest file

EXAMPLES
  $ sf omega manifest test -h
  $ sf omega manifest test -x manifest/package.xml -w *Test
  $ sf omega manifest test -x manifest/package.xml -w *Test -j " -t "

`sf omega:project:setup`

Configure Best Practices for a SF project

USAGE
  $ sf omega:project:setup [--json] [--flags-dir <value>] [-e] [-p] [-c commitlint|lintstaged|all...] [--pipelines]
    [--lint-staged] [--commitlint]

FLAGS
  -c, --pre-commit-hooks=<option>...  Pre-commit hooks to add to git (Using husky). Its no-op if "skip-package"
                                      <options: commitlint|lintstaged|all>
  -e, --skip-extensions               To skip the VSCode extensions installation
  -p, --skip-package                  To skip the package.json update
      --commitlint                    If commit lint hook should be run on pre-commit
      --lint-staged                   If lint-staged hook should be run on pre-commit
      --pipelines                     If bitbucket pipelines file should be created

GLOBAL FLAGS
  --flags-dir=<value>  Import flag values from a directory.
  --json               Format output as json.

DESCRIPTION
  Configure Best Practices for a SF project

  Configure SF project to met the Omega best practices

EXAMPLES
  $ sf omega:project:setup
  $ sf omega:project:setup -p
  $ sf omega:project:setup -e
  $ sf omega:project:setup -p -e

`sf omega:project:types`

Configure Best Practices for a SF project

USAGE
  $ sf omega:project:types -x <value> -o <value> [--json] [--flags-dir <value>] [-m <value>...] [-c <value>...] [-l] [-p
    <value>]

FLAGS
  -c, --class=<value>...    Apex class to generate type declarations. Wiill generate namespace and inner types for inner
                            classes
  -l, --lib                 Add LWC lib types
  -m, --object=<value>...   Standard or custom Salesforce Object names to generate type declarations for
  -o, --target-org=<value>  (required) Username or alias of the target org. Not required if the `target-org`
                            configuration variable is already set.
  -p, --base-path=<value>   [default: /opt/atlassian/pipelines/agent/build] If using "local" flag, the base path to look
                            for files. Defaults to $CWD
  -x, --output=<value>      (required) The directory where the generated type definitions will be stored

GLOBAL FLAGS
  --flags-dir=<value>  Import flag values from a directory.
  --json               Format output as json.

DESCRIPTION
  Configure Best Practices for a SF project

  Generate Typescript type definition files to facilitate type-checking on SFDX porjects

EXAMPLES
  $ sf omega:project:types
  $ sf omega:project:types --object ApexAsyncJob -x ./omega/typings
  $ sf omega:project:types --class MyWrapper --class MyOtherClass -x ./omega/typings
  $ sf omega:project:types --class MyWrapper --class MyOtherClass --local -x ./omega/typings

`sf omega:report:log`

Generates a file with the log of events in the org

USAGE
  $ sf omega:report:log -o <value> [--json] [--flags-dir <value>] [-f <value>] [-t <value>] [-l
    ApexCallout|ApexExecution|ApexRestApi|ApexSoap|ApexTrigger|ApexUnexpectedException|API|ApiTotalUsage|AsyncReportRun|
    AuraRequest|BulkApi|BulkApi2|ChangeSetOperation|ConcurrentLongRunningApexLimit|Console|ContentDistribution|ContentDo
    cumentLink|ContentTransfer|ContinuationCallout|CorsViolation|Dashboard|DocumentAttachmentDownloads|ExternalCrossOrgC
    allout|ExternalCustomApexCallout|ExternalDataSourceCallout|ExternalODataCallout|FlowExecution|HostnameRedirects|Inse
    cureExternalAssets|KnowledgeArticleView|LightningError|LightningInteraction|LightningPageView|LightningPerformance|L
    ogin|LoginAs|Logout|MetadataApiOperation|MultiBlockReport|NamedCredential|OneCommerceUsage|PackageInstall|PlatformEn
    cryption|QueuedExecution|Report|ReportExport|RestApi|Sandbox|Search|SearchClick|Sites|TimeBasedWorkflow|TransactionS
    ecurity|UITracking|URI|VisualforceRequest|WaveChange|WaveDownload|WaveInteraction|WavePerformance...] [-d <value>]
    [-x <value>] [-m]

FLAGS
  -d, --date=<value>
      Date to which to start and end the report (YYYY-MM-DD)

  -f, --from=<value>
      Date from which to start the report (YYYY-MM-DD)

  -l, --filters=<option>...
      Filter the EventType in list
      <options: ApexCallout|ApexExecution|ApexRestApi|ApexSoap|ApexTrigger|ApexUnexpectedException|API|ApiTotalUsage|Async
      ReportRun|AuraRequest|BulkApi|BulkApi2|ChangeSetOperation|ConcurrentLongRunningApexLimit|Console|ContentDistribution
      |ContentDocumentLink|ContentTransfer|ContinuationCallout|CorsViolation|Dashboard|DocumentAttachmentDownloads|Externa
      lCrossOrgCallout|ExternalCustomApexCallout|ExternalDataSourceCallout|ExternalODataCallout|FlowExecution|HostnameRedi
      rects|InsecureExternalAssets|KnowledgeArticleView|LightningError|LightningInteraction|LightningPageView|LightningPer
      formance|Login|LoginAs|Logout|MetadataApiOperation|MultiBlockReport|NamedCredential|OneCommerceUsage|PackageInstall|
      PlatformEncryption|QueuedExecution|Report|ReportExport|RestApi|Sandbox|Search|SearchClick|Sites|TimeBasedWorkflow|Tr
      ansactionSecurity|UITracking|URI|VisualforceRequest|WaveChange|WaveDownload|WaveInteraction|WavePerformance>

  -m, --multiple
      Save each log file in a csv file.

  -o, --target-org=<value>
      (required) Summary of the flag

  -t, --to=<value>
      Date to which to end the report (YYYY-MM-DD)

  -x, --output=<value>
      The file to save the report to.

GLOBAL FLAGS
  --flags-dir=<value>  Import flag values from a directory.
  --json               Format output as json.

DESCRIPTION
  Generates a file with the log of events in the org

  Generates a file with the log of events in the org

EXAMPLES
  $ sf omega:report:log -h
  $ sf omega:report:log -f 2021-01-01 -t 2021-01-31
  $ sf omega:report:log -d 2021-01-01 -m
  $ sf omega:report:log -l Login

`sf omega:report:permission`

Create a report with all the permissions of the objects in the org'

USAGE
  $ sf omega:report:permission -o <value> [--json] [--flags-dir <value>] [-s] [-r] [-p <value>] [-u <value>] [-f <value>] [-l
    <value>...]

FLAGS
  -f, --filter=<value>               Regex expression to filter the objects
  -l, --like=<value>...              Sobjects to filter (e.g. Account,Contact...)
  -o, --target-org=<value>           (required) Org to load to
  -p, --outputprofile=<value>        [default: ProfilePermissions] The file to save the profile permissions to.
  -r, --profile                      If set, save the profile permissions to a file
  -s, --permissionset                If set, save the permissions set permissions to a file
  -u, --outputpermissionset=<value>  [default: PermissionsSet] The file to save the permissions set permissions to.

GLOBAL FLAGS
  --flags-dir=<value>  Import flag values from a directory.
  --json               Format output as json.

DESCRIPTION
  Create a report with all the permissions of the objects in the org'

  Create a report with all the permissions of the objects in the org'

EXAMPLES
  $ sf omega report permission -h
  $ sf omega report permission -s -p PermissionsSet
  $ sf omega report permission -r -p ProfilePermissions
  $ sf omega report permission -p ProfilePermissions -u PermissionsSet
  $ sf omega report permission -l "Account" "Contact" (Retrieve only Account and Contact permissions)
  $ sf omega report permission -f "__c$" (Retrieve only custom objects permissions)

@omegacrm/omega-dx

Omega DX

Development

Documentation

sf omega doc erd

sf omega:audit:automation

sf omega:audit:deadcode

sf omega:audit:dependencies

sf omega:audit:doctor

sf omega:audit:emptyobjects

sf omega:audit:guest

sf omega:audit:namingconventions

sf omega:audit:object

sf omega:confluence:export

sf omega:confluence:update

sf omega:data:fakedata

sf omega:data:loader

sf omega:deploy

sf omega:doc:apexdoc

sf omega:doc:packages

sf omega:doc:uml

sf omega:lwc:oss:convert

sf omega:lwc:oss:create

sf omega:manifest:diff

sf omega:manifest:files

sf omega:manifest:generate

sf omega:manifest:mdtfromobj

sf omega:manifest:test

sf omega:project:setup

sf omega:project:types

sf omega:report:log

sf omega:report:permission

Dependencies (15)

Dev Dependencies (22)

Package Sidebar

Install

Repository

Homepage

DownloadsWeekly Downloads

Version

License

Unpacked Size

Total Files

Last publish

Collaborators

`sf omega doc erd`

`sf omega:audit:automation`

`sf omega:audit:deadcode`

`sf omega:audit:dependencies`

`sf omega:audit:doctor`

`sf omega:audit:emptyobjects`

`sf omega:audit:guest`

`sf omega:audit:namingconventions`

`sf omega:audit:object`

`sf omega:confluence:export`

`sf omega:confluence:update`

`sf omega:data:fakedata`

`sf omega:data:loader`

`sf omega:deploy`

`sf omega:doc:apexdoc`

`sf omega:doc:packages`

`sf omega:doc:uml`

`sf omega:lwc:oss:convert`

`sf omega:lwc:oss:create`

`sf omega:manifest:diff`

`sf omega:manifest:files`

`sf omega:manifest:generate`

`sf omega:manifest:mdtfromobj`

`sf omega:manifest:test`

`sf omega:project:setup`

`sf omega:project:types`

`sf omega:report:log`

`sf omega:report:permission`

Weekly Downloads