0.0.2 • Published 2 years ago
@pogilvie/dx v0.0.2
@pogilvie/sfdx
pogilvie sfdx plugins
Version 0.0.6 query
- read soql query from a file
- print a table
$ npm install -g @pogilvie/dx
$ sfdx COMMAND
running command...
$ sfdx (-v|--version|version)
@pogilvie/dx/0.0.2 darwin-arm64 node-v16.15.0
$ sfdx --help [COMMAND]
USAGE
$ sfdx COMMAND
...sfdx pogilvie:apexrest:post -e <string> -f <filepath> [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]sfdx pogilvie:cdc:subscribe [-s] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]sfdx pogilvie:crud:create -s <string> -f <filepath> [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]sfdx pogilvie:crud:delete -s <string> -i <string> [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]sfdx pogilvie:crud:read -s <string> -i <string> [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]sfdx pogilvie:crud:update -s <string> -f <filepath> [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]sfdx pogilvie:describe:relationships -s <string> [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]sfdx pogilvie:event:subscribe -e <string> [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]sfdx pogilvie:gen:run -e <string> [-i <integer>] [-t <integer>] [-c <integer>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]sfdx pogilvie:query:soql -f <filepath> [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]sfdx pogilvie:ui:call -s <string> -r <string> -p <string> [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
sfdx pogilvie:apexrest:post -e <string> -f <filepath> [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
POST to an apexrest endpoint with a payload specified by a JSON file
USAGE
$ sfdx pogilvie:apexrest:post -e <string> -f <filepath> [--json] [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
OPTIONS
-e, --endpoint=endpoint (required) resource path of the
apexrest service
-f, --file=file (required) json file
--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 apexrest:post -e /newaccount -f ./payload.json -u my-org-alias
where account.json looks like
{
"Name": "Doe Account",
"Phone": "123-555-1212",
"BillingStreet" : "123 Main Street",
"BillingCity" : "Any Town",
"BillingState" : "CA",
"BillingCountry": "US"
}
protected static requiresUsername = true;
protected static requiresProject = false;See code: src/commands/pogilvie/apexrest/post.ts
sfdx pogilvie:cdc:subscribe [-s] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
Subscribe to an org's change data capture stream
USAGE
$ sfdx pogilvie:cdc:subscribe [-s] [-u <string>] [--apiversion <string>] [--json] [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
OPTIONS
-s, --simple simpliied output displaying
operations and changed fields
-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 cdc:subscribe -u my-org-aliasSee code: src/commands/pogilvie/cdc/subscribe.ts
sfdx pogilvie:crud:create -s <string> -f <filepath> [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
Insert a record useing REST from a JSON file
USAGE
$ sfdx pogilvie:crud:create -s <string> -f <filepath> [-u <string>] [--apiversion <string>] [--json] [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
OPTIONS
-f, --file=file (required) json file
-s, --sobject=sobject (required) sobject type Account,
CustomObject__c, ...
-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 crud:create -s Account -f ./account.json -u my-org-alias
where account.json looks like
{
"Name": "Doe Account",
"Phone": "123-555-1212",
"BillingStreet" : "123 Main Street",
"BillingCity" : "Any Town",
"BillingState" : "CA",
"BillingCountry": "US"
}See code: src/commands/pogilvie/crud/create.ts
sfdx pogilvie:crud:delete -s <string> -i <string> [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
Delete a record using REST using a recordId
USAGE
$ sfdx pogilvie:crud:delete -s <string> -i <string> [-u <string>] [--apiversion <string>] [--json] [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
OPTIONS
-i, --ids=ids (required) record id or ids comma
separated with no spaces
-s, --sobject=sobject (required) sobject type Account,
CustomObject__c, ...
-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 crud:delete -s Account, -i 00102000007GstXAAS -u my-org-alias
$ sfdx crud:delete -s Account, -i 00102000007GstXAAS,00102000007GsveAAC -u my-org-aliasSee code: src/commands/pogilvie/crud/delete.ts
sfdx pogilvie:crud:read -s <string> -i <string> [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
Read a record using REST using a recordId
USAGE
$ sfdx pogilvie:crud:read -s <string> -i <string> [-u <string>] [--apiversion <string>] [--json] [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
OPTIONS
-i, --ids=ids (required) record id or ids comma
separated with no spaces
-s, --sobject=sobject (required) sobject type Account,
CustomObject__c, ...
-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 crud:read -s Account, -i 00102000007GstXAAS -u my-org-alias
$ sfdx crud:read -s Account, -i 00102000007GstXAAS,00102000007GsveAAC -u my-org-aliasSee code: src/commands/pogilvie/crud/read.ts
sfdx pogilvie:crud:update -s <string> -f <filepath> [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
USAGE
$ sfdx pogilvie:crud:update -s <string> -f <filepath> [-u <string>] [--apiversion <string>] [--json] [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
OPTIONS
-f, --file=file (required) json file
-s, --sobject=sobject (required) sobject type Account,
CustomObject__c, ...
-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 crud:update -s Account -f ./account.json -u my-org-alias
where account.json looks like
{
"Id": "001S000001LGtY3IAL",
"Phone": "415-123-1212"
}See code: src/commands/pogilvie/crud/update.ts
sfdx pogilvie:describe:relationships -s <string> [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
List relationships defined for an sobject
USAGE
$ sfdx pogilvie:describe:relationships -s <string> [-u <string>] [--apiversion <string>] [--json] [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
OPTIONS
-s, --sobject=sobject (required) sobject type Account,
CustomObject__c, ...
-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 desribe:relationships -s Account -u my-org-aliasSee code: src/commands/pogilvie/describe/relationships.ts
sfdx pogilvie:event:subscribe -e <string> [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
Subscribe to a platform event channel
USAGE
$ sfdx pogilvie:event:subscribe -e <string> [-u <string>] [--apiversion <string>] [--json] [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
OPTIONS
-e, --event=event (required) event type CustomEvent__e
-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 event:subscribe -e event__c -u my-org-aliasSee code: src/commands/pogilvie/event/subscribe.ts
sfdx pogilvie:gen:run -e <string> [-i <integer>] [-t <integer>] [-c <integer>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
Test performance / correctness of a apex rest endpoint
USAGE
$ sfdx pogilvie:gen:run -e <string> [-i <integer>] [-t <integer>] [-c <integer>] [-u <string>] [--apiversion <string>]
[--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
OPTIONS
-c, --concurrency=concurrency [default: 5] number of requests per
interval
-e, --endpoint=endpoint (required) API name of sobject
-i, --iterations=iterations [default: 5] iterations
-t, --interval=interval [default: 1000] interval time in
msec
-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 invocationSee code: src/commands/pogilvie/gen/run.ts
sfdx pogilvie:query:soql -f <filepath> [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
Issue soql query from a file
USAGE
$ sfdx pogilvie:query:soql -f <filepath> [-u <string>] [--apiversion <string>] [--json] [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
OPTIONS
-f, --file=file (required) soql file
-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 query:soql -f ./accounts.soql -u my-org-alias
account.soql:
SELECT Id, Name
FROM Account
WHERE Name like '%Sara%'
output:
ID NAME
001S000001LGtY3IAL Sara Account
001S000001LGdorIAD Sara Account
001S000001LGdowIAD Sara AccountSee code: src/commands/pogilvie/query/soql.ts
sfdx pogilvie:ui:call -s <string> -r <string> -p <string> [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
Call UPI on salesforce record
USAGE
$ sfdx pogilvie:ui:call -s <string> -r <string> -p <string> [-u <string>] [--apiversion <string>] [--json] [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
OPTIONS
-p, --picklist=picklist (required) API name of picklist
field
-r, --recordtypeid=recordtypeid (required) RecordTypeId
-s, --sobject=sobject (required) API name of sobject
-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 invocationSee code: src/commands/pogilvie/ui/call.ts