expereo-sfdx-plugin
v18.5.4
Published
@expereo-it/expereo-sfdx-plugin ===================
Downloads
49
Readme
@expereo-it/expereo-sfdx-plugin
$ npm install -g expereo-sfdx-plugin
$ sfdx COMMAND
running command...
$ sfdx (-v|--version|version)
expereo-sfdx-plugin/18.2.4 darwin-x64 node-v14.19.0
$ sfdx --help [COMMAND]
USAGE
$ sfdx COMMAND
...
sfdx expereo:environment:create -p <string> [-n <string>] [-r] [-v <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
sfdx expereo:notification:teams -m <string> -w <string> [-u <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
sfdx expereo:release:bumppackages [-d <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
sfdx expereo:release:job:abort [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
sfdx expereo:release:job:schedule [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
sfdx expereo:release:validateartifacts -d <string> [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
sfdx expereo:sharing:publicgrouproles:sync -p <filepath> [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
sfdx expereo:sharing:waitready [-t <minutes>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
sfdx expereo:test:emailtocase -s <string> -p <string> [-w <string>] [-e] [-t <number>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
sfdx expereo:workspace:resettracking [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
sfdx expereo:environment:create -p <string> [-n <string>] [-r] [-v <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
Fetch a scratch org from dev pool, and reset the source tracking to latest
USAGE
$ sfdx expereo:environment:create -p <string> [-n <string>] [-r] [-v <string>] [--apiversion <string>] [--json]
[--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
OPTIONS
-n, --name=name Scratch org name.
-p, --devpool=devpool (required) Dev pool to fetch scratch
orgs from, e.g, beta, gamma, etc.
-r, --resettracking Reset tracking
-v, --targetdevhubusername=targetdevhubusername username or alias for the dev hub
org; overrides default dev hub org
--apiversion=apiversion 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
EXAMPLES
sfdx expereo:environment:create -p beta
sfdx expereo:environment:create -p beta -n best-scratch-org
sfdx expereo:environment:create --devpool beta --name best-scratch-org
See code: src/commands/expereo/environment/create.ts
sfdx expereo:notification:teams -m <string> -w <string> [-u <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
Notify release on Teams channel
USAGE
$ sfdx expereo:notification:teams -m <string> -w <string> [-u <string>] [--json] [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
OPTIONS
-m, --message=message (required) Message or MR title
-u, --user=user User email
-w, --webhookurl=webhookurl (required) Teams channel webhook url
--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
EXAMPLE
$ sfdx expereo:notification:teams -u user_email -t mr_title -w webhook_url
See code: src/commands/expereo/notification/teams.ts
sfdx expereo:release:bumppackages [-d <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
Bump all package based on artifacts
USAGE
$ sfdx expereo:release:bumppackages [-d <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
OPTIONS
-d, --artifactdirectory=artifactdirectory Artifacts directory
-u, --targetusername=targetusername username or alias for the target
org; overrides default target org
--apiversion=apiversion 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
EXAMPLE
$ sfdx expereo:release:bumppackages
See code: src/commands/expereo/release/bumppackages.ts
sfdx expereo:release:job:abort [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
Clear all managed schedule classes
USAGE
$ sfdx expereo:release:job:abort [-u <string>] [--apiversion <string>] [--json] [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
OPTIONS
-u, --targetusername=targetusername username or alias for the target
org; overrides default target org
--apiversion=apiversion 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
EXAMPLE
$ sfdx expereo:release:job:abort
See code: src/commands/expereo/release/job/abort.ts
sfdx expereo:release:job:schedule [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
Schedule all classes defined in the jobs.yml
USAGE
$ sfdx expereo:release:job:schedule [-u <string>] [--apiversion <string>] [--json] [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
OPTIONS
-u, --targetusername=targetusername username or alias for the target
org; overrides default target org
--apiversion=apiversion 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
EXAMPLES
$ sfdx expereo:release:job:schedule
Sample of job.yml:
# Sample 1
"Build Run":
class-name: BuildRunSchedule
frequency: 0 0 0 * * ? *
# Sample 2
"Log Cleaning":
class-name: LogCleaningSchedule
frequency: 0 0 18 L * ? *
See code: src/commands/expereo/release/job/schedule.ts
sfdx expereo:release:validateartifacts -d <string> [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
Check if all versions of package are releasable
USAGE
$ sfdx expereo:release:validateartifacts -d <string> [-u <string>] [--apiversion <string>] [--json] [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
OPTIONS
-d, --artifactdirectory=artifactdirectory (required) [default: artifacts]
Artifacts directory
-u, --targetusername=targetusername username or alias for the target
org; overrides default target org
--apiversion=apiversion 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
EXAMPLE
$ sfdx expereo:release:validatepackages
See code: src/commands/expereo/release/validateartifacts.ts
sfdx expereo:sharing:publicgrouproles:sync -p <filepath> [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
Synchronize public group roles to a particular target environment. This command uses the json file src/data/config-data/GroupMembers/GroupMembersByGroupName.json for the synchronization.
USAGE
$ sfdx expereo:sharing:publicgrouproles:sync -p <filepath> [-v <string>] [-u <string>] [--apiversion <string>]
[--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
OPTIONS
-p, --filepath=filepath (required) path to json file for
group roles.
-u, --targetusername=targetusername username or alias for the target
org; overrides default target org
-v, --targetdevhubusername=targetdevhubusername username or alias for the dev hub
org; overrides default dev hub org
--apiversion=apiversion 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
See code: src/commands/expereo/sharing/publicgrouproles/sync.ts
sfdx expereo:sharing:waitready [-t <minutes>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
Waits until all Permission Set Groups are updated
USAGE
$ sfdx expereo:sharing:waitready [-t <minutes>] [-u <string>] [--apiversion <string>] [--json] [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
OPTIONS
-t, --timeout=timeout [default: [object Object]] During in
minutes before command fails
-u, --targetusername=targetusername username or alias for the target
org; overrides default target org
--apiversion=apiversion 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
EXAMPLE
$ sfdx expereo:sharing:waitReady"
all permission set groups were successfully updated
See code: src/commands/expereo/sharing/waitready.ts
sfdx expereo:test:emailtocase -s <string> -p <string> [-w <string>] [-e] [-t <number>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
Executes functional email to case test.
USAGE
$ sfdx expereo:test:emailtocase -s <string> -p <string> [-w <string>] [-e] [-t <number>] [-u <string>] [--apiversion
<string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
OPTIONS
-e, --suppresserror If true, error on failure will be
suppressed.
-p, --senderpass=senderpass (required) Password for email that
sends the test.
-s, --senderemail=senderemail (required) Email that sends the test
email.
-t, --waittime=waittime Waiting time between case queries
timeout defined in seconds. Default
10s.
-u, --targetusername=targetusername username or alias for the target
org; overrides default target org
-w, --webhookurl=webhookurl URL for webhook to send teams
notification.
--apiversion=apiversion 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
EXAMPLE
$sfdx expereo:test:emailtocase -s [email protected] -p somepassword
See code: src/commands/expereo/test/emailtocase.ts
sfdx expereo:workspace:resettracking [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
Reset tracking based on the last revision of scratch org
USAGE
$ sfdx expereo:workspace:resettracking [-u <string>] [--apiversion <string>] [--json] [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
OPTIONS
-u, --targetusername=targetusername username or alias for the target
org; overrides default target org
--apiversion=apiversion 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
EXAMPLE
$ sfdx expereo:project:resettracking"
Reset tracking based on the last revision of scratch org
See code: src/commands/expereo/workspace/resettracking.ts
Debugging your plugin
We recommend using the Visual Studio Code (VS Code) IDE for your plugin development. Included in the .vscode
directory of this plugin is a launch.json
config file, which allows you to attach a debugger to the node process when running your commands.
To debug the expereo:org
command:
- Start the inspector
If you linked your plugin to the sfdx cli, call your command with the dev-suspend
switch:
$ sfdx expereo:org -u [email protected] --dev-suspend
Alternatively, to call your command using the bin/run
script, set the NODE_OPTIONS
environment variable to --inspect-brk
when starting the debugger:
$ NODE_OPTIONS=--inspect-brk bin/run expereo:org -u [email protected]
- Set some breakpoints in your command code
- Click on the Debug icon in the Activity Bar on the side of VS Code to open up the Debug view.
- In the upper left hand corner of VS Code, verify that the "Attach to Remote" launch configuration has been chosen.
- Hit the green play button to the left of the "Attach to Remote" launch configuration window. The debugger should now be suspended on the first line of the program.
- Hit the green play button at the top middle of VS Code (this play button will be to the right of the play button that you clicked in step #5). Congrats, you are debugging!