Pony sfdx plugin to automate application lifecycle.
Pony sfdx plugin to automate your application lifecycle.
sfdx plugins:install @pony-ci/sfdx-plugin* Docs: https://pony-ci.github.io/pony-ci-docs/
* Issues: https://github.com/pony-ci/sfdx-plugin/issues
sh-session
$ npm install -g @pony-ci/sfdx-plugin
$ sfdx COMMAND
running command...
$ sfdx (-v|--version|version)
@pony-ci/sfdx-plugin/1.0.1 linux-x64 node-v8.10.0
$ sfdx --help [COMMAND]
USAGE
$ sfdx COMMAND
...
`
Commands
* [](#sfdx-pony---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
* [sfdx pony:connectedapp:deploy -l ](#sfdx-ponyconnectedappdeploy--l-string--e-string--s-string---callbackurl-string--c-string--d-string--p--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
* [sfdx pony:data:export [-u ](#sfdx-ponydataexport--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
* [sfdx pony:data:import [--noprompt] [-u ](#sfdx-ponydataimport---noprompt--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
* [sfdx pony:data:soql:query:create [-s ](#sfdx-ponydatasoqlquerycreate--s-string--p---excludeparentfields---includenoncreateable--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
* [sfdx pony:group:assign -g ](#sfdx-ponygroupassign--g-string--t-allcustomerportalchannelprogramgroupcollaborationgroupmanagermanagerandsubordinatesinternalorganizationprmorganizationqueueregularroleroleandsubordinatesroleandsubordinatesinternalterritoryterritoryandsubordinates---userorgroup-string--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
* [sfdx pony:org:create [name=value...] [-s] [-a ](#sfdx-ponyorgcreate-namevalue--s--a-string--d-integer--w-number--v-string--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
* [sfdx pony:package:group:export [-n ](#sfdx-ponypackagegroupexport--n-string--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
* [sfdx pony:package:group:install [-g ](#sfdx-ponypackagegroupinstall--g-string--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
* [sfdx pony:run [--onlyifdefined] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]](#sfdx-ponyrun---onlyifdefined---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
* [sfdx pony:source:content:replace -r ](#sfdx-ponysourcecontentreplace--r-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
* [sfdx pony:source:push [-f] [-g] [-w ](#sfdx-ponysourcepush--f--g--w-number--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
* [sfdx pony:source:sort [-f ](#sfdx-ponysourcesort--f-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
* [sfdx pony:user:create [name=value...] [-a ](#sfdx-ponyusercreate-namevalue--a-string--p-string--f-string--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
* [sfdx pony:user:profile:assign -p ](#sfdx-ponyuserprofileassign--p-string--a-string--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
* [sfdx pony:user:update -v ](#sfdx-ponyuserupdate--v-string--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)sfdx pony [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
USAGE
$ sfdx pony [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]OPTIONS
--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
create connected app
USAGE
$ sfdx pony:connectedapp:deploy -l -e [-s ] [--callbackurl ] [-c ] [-d
] [-p] [-u ] [--apiversion ] [--json] [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]OPTIONS
-c, --certificate=certificate
path to certificate
-d, --targetdir=targetdir
directory for the connected app
-e, --contactemail=contactemail
(required) connected app contact email
-l, --label=label
(required) connected app label
-p, --noprompt
do not prompt connected app deployment
-s, --scopes=scopes
comma-separated OAuth scopes; valid values are Basic, Api, Web, Full, Chatter, CustomApplications, RefreshToken,
OpenID, Profile, Email, Address, Phone, OfflineAccess, CustomPermissions, Wave, Eclair
-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
--callbackurl=callbackurl
callback 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
DESCRIPTION
Set target directory to write the connected app.
Example:
sfdx pony:connectedapp:create -u myOrg -l "My CI" -s Api,Web,RefreshToken -c /path/to/cert.crt -e john@acme.com
--callbackurl http://localhost:1717/OauthRedirect
export records
USAGE
$ sfdx pony:data:export [-u ] [--apiversion ] [--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
DESCRIPTION
Use 'sfdx force:data:soql:query:create' command to create a query for export.
import records
USAGE
$ sfdx pony:data:import [--noprompt] [-u ] [--apiversion ] [--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
--noprompt Allow data import to all instances
without prompt.
create file with soql query for exporting records
USAGE
$ sfdx pony:data:soql:query:create [-s ] [-p] [--excludeparentfields] [--includenoncreateable] [-u ]
[--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]OPTIONS
-p, --noprompt no prompt to confirm overwrite
-s, --sobjecttype=sobjecttype the API name of the object to create
query, (default: all sobjects
defined in config)
-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
--excludeparentfields exclude parent name fields, e.g.
"RecordType.Name"
--includenoncreateable include only createable fields are
added
--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
assign public group
USAGE
$ sfdx pony:group:assign -g [-t
AllCustomerPortal|ChannelProgramGroup|CollaborationGroup|Manager|ManagerAndSubordinatesInternal|Organization|PRMOrgani
zation|Queue|Regular|Role|RoleAndSubordinates|RoleAndSubordinatesInternal|Territory|TerritoryAndSubordinates]
[--userorgroup ] [-u ] [--apiversion ] [--json] [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]OPTIONS
-g, --group=group
(required) developer names of the Group
-t,
--type=(AllCustomerPortal|ChannelProgramGroup|CollaborationGroup|Manager|ManagerAndSubordinatesInternal|Organization|P
RMOrganization|Queue|Regular|Role|RoleAndSubordinates|RoleAndSubordinatesInternal|Territory|TerritoryAndSubordinates)
type of the Group
-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
--userorgroup=userorgroup
ID of the User or Group that is a direct member of the group (default: target username)
DESCRIPTION
Developer Guide:
* https://developer.salesforce.com/docs/atlas.en-us.api.meta/api/sforce_api_objects_group.htm
* https://developer.salesforce.com/docs/atlas.en-us.api.meta/api/sforce_api_objects_groupmember.htm
Supported Group types:
* AllCustomerPortal
* ChannelProgramGroup
* CollaborationGroup
* Manager
* ManagerAndSubordinatesInternal
* Organization
* PRMOrganization
* Queue
* Regular
* Role
* RoleAndSubordinates
* RoleAndSubordinatesInternal
* Territory
* TerritoryAndSubordinates
EXAMPLES
$ sfdx pony:group:assign -g My_Queue
$ sfdx pony:group:assign -t Queue -g Fist_Queue,Second_Queue
$ sfdx pony:group:assign -t Queue -g My_Queue --userorgroup 0053N000002EP0zQAG
create a fully configured scratch org
USAGE
$ sfdx pony:org:create [name=value...] [-s] [-a ] [-d ] [-w ] [-v ] [-u ]
[--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]OPTIONS
-a, --setalias=setalias alias for the created org
-d, --durationdays=durationdays duration of the scratch org;
override value in config (in days)
(default: config value or 7, min:1,
max:30)
-s, --setdefaultusername set the created org as the default
username
-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
-w, --wait=wait [default: 6] the streaming client
socket timeout (in minutes)
--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
DESCRIPTION
Provide key=value pairs while creating a scratch org. When creating scratch orgs, --targetdevhubusername (-v) must be
a Dev Hub org.
No ancestors, no namespace, duration days, definition file and username generation
options can be configured in pony config.
Duration days flag will override the value in config (or default value if not specified in config).
Execution Flow:
1) Set 'username' and 'devhubusername' env values if existing org is used (either targetusername flag or default
org).
2) Run 'pony:preOrgCreate' job if existing org is not used.
3) Run 'force:org:create' command and set 'username' and 'devhubusername' env values if existing org is not used.
4) Run 'pony:postOrgCreate' job on success.
export a package group from configured org for scratch org creation
USAGE
$ sfdx pony:package:group:export [-n ] [-u ] [--apiversion ] [--json] [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]OPTIONS
-n, --group=group [default: default] name of the
package group
-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
DESCRIPTION
Exported package group is an ordered list of packages that can be installed with the 'sfdx pony:package:group:install'
command.
install a package group
USAGE
$ sfdx pony:package:group:install [-g ] [-u ] [--apiversion ] [--json] [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]OPTIONS
-g, --group=group [default: default] name of the
package group
-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
DESCRIPTION
To create a package group run the 'sfdx pony:package:group:export' command.
run job defined in config
USAGE
$ sfdx pony:run [--onlyifdefined] [--json] [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]OPTIONS
--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
--onlyifdefined execute the job only if defined,
otherwise throw error
replace values in xml component files
USAGE
$ sfdx pony:source:content:replace -r [--json] [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]OPTIONS
-r, --replacement=replacement (required) name of the replacement
--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
push source to a scratch org from the project
USAGE
$ sfdx pony:source:push [-f] [-g] [-w ] [-u ] [--apiversion ] [--json] [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]OPTIONS
-f, --forceoverwrite ignore conflict warnings and
overwrite changes to scratch org
-g, --ignorewarnings deploy changes even if warnings are
generated
-u, --targetusername=targetusername username or alias for the target
org; overrides default target org
-w, --wait=wait [default: 33] wait time for command
to finish in minutes
--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
DESCRIPTION
Execution Flow:
1) Run 'pony:preSourcePush' job if existing org is not used.
2) Run 'force:source:push' command.
3) Run 'pony:postSourcePush' job on success.
sort xml source files
USAGE
$ sfdx pony:source:sort [-f ] [--json] [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]OPTIONS
-f, --files=files comma separated list of files
--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
If no files are specified, command will sort files defined in .pony/config.json.
Possible values in the config are 'source', 'all', 'none' or array of files, default value is 'source'.
Supported metadata:
* Profile
EXAMPLES
$ sfdx pony:source:sort
$ sfdx pony:source:sort -f src/main/default/profiles/Admin.profile-meta.xml
$ sfdx pony:source:sort -f src/main/default/profiles/Admin.profile-meta.xml
src/main/default/profiles/Standard.profile-meta.xml
$ sfdx pony:source:sort -f src/main/default/profiles/*
create a user by name defined in config
USAGE
$ sfdx pony:user:create [name=value...] [-a ] [-p ] [-f ] [-u ] [--apiversion
] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]OPTIONS
-a, --setalias=setalias alias for the created org
-f, --definitionfile=definitionfile file path to a user definition
-p, --prefix=prefix username prefix
-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
assign a profile to a user
USAGE
$ sfdx pony:user:profile:assign -p [-a ] [-u ] [--apiversion ] [--json] [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]OPTIONS
-a, --assigner=assigner user who will assign the profile,
this user must be authorized
-p, --profile=profile (required) name of the profile
-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
DESCRIPTION
Assigner is a user who will assign the profile.
If not specified, a user is created and after assignment deactivated.
On behalf of is a list of users whom to assign the profile.
If not specified, the profile is assigned to target username.
update target user
USAGE
$ sfdx pony:user:update -v [-u ] [--apiversion ] [--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
-v, --values=values (required) a list of
= pairs to search
for
--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