sfdx-data-dictonary
v1.0.2
Published
this is a custom plugin to generate the data dictonary for the selected objects, generates the permissions matrix, report for field usage for an object
Downloads
11
Maintainers
Readme
SFDX Data Dictonary
this is a custom plugin to generate the data dictonary for the selected objects
Installation
sfdx plugins:install sfdx-data-dictonary
Issues
USAGE
USAGE
$ sfdx data:dictonary --help
$ sfdx code:coverage --help
$ sfdx perm:list --help
$ sfdx field:usage --help
sfdx code:coverage [-n <string>] [-a] [-c] [-p <string>] [-f <string>] [--wait <minutes>] [--notify <url>] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
sfdx data:dictonary [-p <string>] [-o <string>] [-t <string>] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
sfdx field:usage -o <string> [-p <string>] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
sfdx md:dependency:generate -x <string> [-p <string>] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
sfdx perm:list -n <string> -f <string> [-o <string>] [-t <string>] [-p <string>] [-s <string>] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
sfdx code:coverage [-n <string>] [-a] [-c] [-p <string>] [-f <string>] [--wait <minutes>] [--notify <url>] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
runs and generate the code coverage in given format
USAGE
$ sfdx code:coverage [-n <string>] [-a] [-c] [-p <string>] [-f <string>] [--wait <minutes>] [--notify <url>] [-v
<string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
FLAGS
-a, --aggregate Use this flag, if you wanted to get
the aggregated code coverage by
components
-c, --coverage Use this flag, if you wanted to get
the code coverage by test methods
for components
-f, --format=<value> [default: table] format in which you
want to get the code coverage
report. Valid values are table, xlsx
& html
-n, --name=<value> class name to get the coverage %
-p, --file=<value> Fully qualified path with file name
where you want to store the code
coverage in xlsx/html format
-u, --targetusername=<value> username or alias for the target
org; overrides default target org
-v, --targetdevhubusername=<value> username or alias for the dev hub
org; overrides default dev hub org
--apiversion=<value> override the api version used for
api requests made by this command
--json format output as json
--loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
this command invocation
--notify=<value> url to notify upon completion
--wait=<value> number of minutes to wait for
creation
DESCRIPTION
runs and generate the code coverage in given format
EXAMPLES
sfdx code:coverage -u [email protected] --aggregate
sfdx code:coverage -u [email protected] --aggregate --json
sfdx code:coverage -u [email protected] --aggregate --format xlsx --name AccountTriggerTest --file ./coverage/CoverageReport.xlsx
sfdx code:coverage -u [email protected] --aggregate --format xlsx --file ./coverage/CoverageReport.xlsx
sfdx code:coverage -u [email protected] --aggregate --format html --file ./coverage/CoverageReport.html
sfdx code:coverage -u [email protected] --aggregate --format table
sfdx code:coverage -u [email protected] --aggregate --format table --name AccountTriggerTest
See code: src/commands/code/coverage.ts
sfdx data:dictonary [-p <string>] [-o <string>] [-t <string>] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
generates the metadata for the selected object and exports as slsx format, medata includes object, field, apex trigger, record trigger flows & validation rules
USAGE
$ sfdx data:dictonary [-p <string>] [-o <string>] [-t <string>] [-v <string>] [-u <string>] [--apiversion
<string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
FLAGS
-o, --objects=<value> Comma Seperated API name of objects
to get field metadata Info
-p, --path=<value> File Name with full Path to create
Excel File
-t, --type=<value> Ditermines the type of object. Valid
values are Custom and Standard.
Custom also includes metadata,
custom settings and external objects
-u, --targetusername=<value> username or alias for the target
org; overrides default target org
-v, --targetdevhubusername=<value> username or alias for the dev hub
org; overrides default dev hub org
--apiversion=<value> override the api version used for
api requests made by this command
--json format output as json
--loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
this command invocation
DESCRIPTION
generates the metadata for the selected object and exports as slsx format, medata includes object, field, apex
trigger, record trigger flows & validation rules
EXAMPLES
sfdx data:dictonary -u [email protected] --objects "Account,Lead" -p "./path/to/file/file.xlsx"
sfdx data:dictonary -u [email protected] --objects "Account,Lead"
sfdx data:dictonary -u [email protected] --objects "Account,Lead" --json
sfdx data:dictonary -u [email protected]
See code: src/commands/data/dictonary.ts
sfdx field:usage -o <string> [-p <string>] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
analyse the field usage for a given object and generates a report
USAGE
$ sfdx field:usage -o <string> [-p <string>] [-v <string>] [-u <string>] [--apiversion <string>] [--json]
[--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
FLAGS
-o, --object=<value> (required) Name of the object to
analyse
-p, --path=<value> full Path to generate the output
file
-u, --targetusername=<value> username or alias for the target
org; overrides default target org
-v, --targetdevhubusername=<value> username or alias for the dev hub
org; overrides default dev hub org
--apiversion=<value> override the api version used for
api requests made by this command
--json format output as json
--loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
this command invocation
DESCRIPTION
analyse the field usage for a given object and generates a report
EXAMPLES
sfdx field:usage -u username-alias --object "Account"
sfdx field:usage -u username-alias --object "Account" --path "./path/to/report/folder/FieldUsage.xlsx"
sfdx field:usage -u username-alias --object "Account" --path "FieldUsage.xlsx"
See code: src/commands/field/usage.ts
sfdx md:dependency:generate -x <string> [-p <string>] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
generates the metadata dependency based the given package.xml
USAGE
$ sfdx md:dependency:generate -x <string> [-p <string>] [-v <string>] [-u <string>] [--apiversion <string>] [--json]
[--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
FLAGS
-p, --path=<value> full Path to generate the output
file
-u, --targetusername=<value> username or alias for the target
org; overrides default target org
-v, --targetdevhubusername=<value> username or alias for the dev hub
org; overrides default dev hub org
-x, --manifest=<value> (required) path to package.xml file
to generate the package.xml with
dependency
--apiversion=<value> override the api version used for
api requests made by this command
--json format output as json
--loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
this command invocation
DESCRIPTION
generates the metadata dependency based the given package.xml
EXAMPLES
sfdx md:dependency:generate -x ./manifest/package.xml -u utils
sfdx md:dependency:generate -x ./manifest/package.xml --path ./dependency/package.xml -u utils
sfdx md:dependency:generate --manifest ./manifest/package.xml -u utils
sfdx md:dependency:generate --manifest ./manifest/package.xml --path ./dependency/package.xml -u utils
See code: src/commands/md/dependency/generate.ts
sfdx perm:list -n <string> -f <string> [-o <string>] [-t <string>] [-p <string>] [-s <string>] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
list all the permissions at profile level for the given object & it's all fields
USAGE
$ sfdx perm:list -n <string> -f <string> [-o <string>] [-t <string>] [-p <string>] [-s <string>] [-v
<string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
FLAGS
-f, --format=<value> (required) format in which you want
to get the report. Valid values are
xlsx & html
-n, --name=<value> (required) the name of the file to
be written
-o, --object=<value> Name of the object to analyse
-p, --profile=<value> name of the profile to get the
permissions
-s, --permissionset=<value> name of the permission set to get
the permissions
-t, --touser=<value> a valid username for whom you want
to analyse the permissions
-u, --targetusername=<value> username or alias for the target
org; overrides default target org
-v, --targetdevhubusername=<value> username or alias for the dev hub
org; overrides default dev hub org
--apiversion=<value> override the api version used for
api requests made by this command
--json format output as json
--loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
this command invocation
DESCRIPTION
list all the permissions at profile level for the given object & it's all fields
EXAMPLES
sfdx perm:list -u utils -o "Account" -n ObjectPermissions.html --format html
sfdx perm:list -u utils -o "Account" -n ObjectPermissions.xlsx --format xlsx
sfdx perm:list -u utils -o "Account" -n ObjectPermissions.html --touser [email protected] --format html
sfdx perm:list -u utils -o "Account" -n ObjectPermissions.xlsx --touser [email protected] --format xlsx
sfdx perm:list -u utils -n ObjectPermissions.xlsx --format xlsx
sfdx perm:list -u utils -n ObjectPermissions.html --format html
sfdx perm:list -u utils -n ObjectPermissions.html --format html --profile "System Administrator"
sfdx perm:list -u utils -n ObjectPermissions.html --format html --permissionset "Permission Set"
See code: src/commands/perm/list.ts