veloce-sfdx-v3
v0.0.37
Published
Extension to sfdx which allows veloce specific data pull and push
Downloads
70
Readme
veloce
Extension to sfdx which allows veloce specific data pull and push
<!-- install -->
<!-- usage -->
$ npm install -g veloce-sfdx-v3
$ sfdx COMMAND
running command...
$ sfdx (-v|--version|version)
veloce-sfdx-v3/0.0.37 darwin-x64 node-v18.16.1
$ sfdx --help [COMMAND]
USAGE
$ sfdx COMMAND
...
sfdx veloce:data:pull [-m <string>] [-w <string>] [-s <string>] [-p <string>] [-o <string>] [-R <string>] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
sfdx veloce:data:push [-m <string>] [-p <string>] [-P] [-s <string>] [-e <string>] [-R <string>] [-P] [-U] [-d] [-D] [-o <string>] [-b <string>] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
sfdx veloce:debug:list [-P] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
sfdx veloce:debug:logs [-P] [-l debug|info|warn|error|DEBUG|INFO|WARN|ERROR] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
sfdx veloce:debug:push -m <string> [-p <string>] [-P] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
sfdx veloce:debug:start [-P] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
sfdx veloce:debug:stop [-P] [--dev-token <string>] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
sfdx veloce:debug:watch [-p <string>] [-P] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
sfdx veloce:fixref3 [-d] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
sfdx veloce:login -p <string> -a <string> -u <string> -r <string> [-s <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
sfdx veloce:source:pack -m <string> [-p <string>] [-o <string>] [-I <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
sfdx veloce:source:pull [-m <string>] [-p <string>] [-P] [-I <string>] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
sfdx veloce:source:push [-m <string>] [-p <string>] [-P] [-d] [-I <string>] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
sfdx veloce:data:pull [-m <string>] [-w <string>] [-s <string>] [-p <string>] [-o <string>] [-R <string>] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
Retrieves data from Salesforce org and stores it in provided folder as CSVs
USAGE
$ sfdx veloce:data:pull [-m <string>] [-w <string>] [-s <string>] [-p <string>] [-o <string>] [-R <string>] [-v
<string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
OPTIONS
-R, --idreplacefields=idreplacefields Coma separated list of fields in
which SF IDs are replaces by mapped
Ids by using text search and replace
-m, --members=members Pull only specific type of data or
even name of object
-o, --ignorefields=ignorefields Coma separated list of fields to
ignore during dump. To append to the
default list of ignored fields add +
in the front.
-p, --sourcepath=sourcepath Path to file where to read data
-s, --sobjecttype=sobjecttype The sObject type of the records you
want to dump.
-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, --where=where where condition to filter sObjects
by
--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 veloce:data:pull --targetusername [email protected] --targetdevhubusername [email protected] --sourcepath
./source/templates
sfdx veloce:data:pull --targetusername [email protected] --targetdevhubusername [email protected] --sourcepath
./source/templates --members price-list:OctaPriceListName
See code: src/commands/veloce/data/pull.ts
sfdx veloce:data:push [-m <string>] [-p <string>] [-P] [-s <string>] [-e <string>] [-R <string>] [-P] [-U] [-d] [-D] [-o <string>] [-b <string>] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
Uploads Data from CSVs to Salesforce org
USAGE
$ sfdx veloce:data:push [-m <string>] [-p <string>] [-P] [-s <string>] [-e <string>] [-R <string>] [-P] [-U] [-d] [-D]
[-o <string>] [-b <string>] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
OPTIONS
-D, --diff Force diff mode ON, it will show
differences for each record which is
upserted/inserted. Default: ON if <
128 records and off otherwise.
-P, --noproject Bypass check of sfdx-project.json to
exist
-P, --printids Print External ID before attempting
to update
-R, --idreplacefields=idreplacefields Coma separated list of fields in
which SF IDs are replaces by mapped
Ids by using text search and replace
-U, --upsert Should use APEX upsert (could insert
extra records) or update-only APEX
(one by one), which is default
-b, --batch=batch Size of batch, to avoid getting
'script is too large'
-d, --dry Dont change data, just run in dry
mode
-e, --externalid=externalid The column name of the external ID.
-m, --members=members Pushes only specific type of data or
even name of object
-o, --ignorefields=ignorefields Coma separated list of fields to
ignore during load
-p, --sourcepath=sourcepath Path where to get data
-s, --sobjecttype=sobjecttype The sObject type of the records you
want to upsert.
-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
EXAMPLE
sfdx veloce:data:pull --targetusername [email protected] --targetdevhubusername [email protected] --members model:Octa
--sourcepath ./source/templates
See code: src/commands/veloce/data/push.ts
sfdx veloce:debug:list [-P] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
Lists debug sessions
USAGE
$ sfdx veloce:debug:list [-P] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
OPTIONS
-P, --noproject Bypass check of sfdx-project.json to
exist
-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
EXAMPLE
sfdx veloce:debug:list --targetusername [email protected] --targetdevhubusername [email protected]
See code: src/commands/veloce/debug/list.ts
sfdx veloce:debug:logs [-P] [-l debug|info|warn|error|DEBUG|INFO|WARN|ERROR] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
Streams logs out of debug session to console
USAGE
$ sfdx veloce:debug:logs [-P] [-l debug|info|warn|error|DEBUG|INFO|WARN|ERROR] [-v <string>] [-u <string>]
[--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
OPTIONS
-P, --noproject Bypass check of sfdx-project.json to
exist
-l, --debugsessionloglevel=(debug|info|warn|error|DEBUG|INFO|WARN|ERROR) [default: debug] Logging level for
debug session
-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
EXAMPLE
sfdx veloce:debug:logs --targetusername [email protected] --targetdevhubusername [email protected] --debugsessionloglevel
warn
See code: src/commands/veloce/debug/logs.ts
sfdx veloce:debug:push -m <string> [-p <string>] [-P] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
Pushes changes to debug session manually
USAGE
$ sfdx veloce:debug:push -m <string> [-p <string>] [-P] [-v <string>] [-u <string>] [--apiversion <string>] [--json]
[--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
OPTIONS
-P, --noproject Bypass check of sfdx-project.json to
exist
-m, --members=members (required) Type of meta data to
deploy
-p, --sourcepath=sourcepath Path to meta data
-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
EXAMPLES
sfdx veloce:debug:push --targetusername [email protected] --targetdevhubusername [email protected]
sfdx veloce:debug:push --targetusername [email protected] --targetdevhubusername [email protected] -m
model:name_of_my_model -p ./source/my-alternative-model-folder
See code: src/commands/veloce/debug/push.ts
sfdx veloce:debug:start [-P] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
Starts new ISOLATED debug session
USAGE
$ sfdx veloce:debug:start [-P] [-u <string>] [--apiversion <string>] [--json] [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
OPTIONS
-P, --noproject Bypass check of sfdx-project.json to
exist
-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 veloce:debug:start --targetusername [email protected] --targetdevhubusername [email protected]
See code: src/commands/veloce/debug/start.ts
sfdx veloce:debug:stop [-P] [--dev-token <string>] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
Stops debug session
USAGE
$ sfdx veloce:debug:stop [-P] [--dev-token <string>] [-v <string>] [-u <string>] [--apiversion <string>] [--json]
[--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
OPTIONS
-P, --noproject Bypass check of sfdx-project.json to
exist
-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
--dev-token=dev-token Dev Session token
--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 veloce:debug:stop --targetusername [email protected] --targetdevhubusername [email protected]
See code: src/commands/veloce/debug/stop.ts
sfdx veloce:debug:watch [-p <string>] [-P] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
Watches filesystem for changes and automatically propagates them to backend
USAGE
$ sfdx veloce:debug:watch [-p <string>] [-P] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
OPTIONS
-P, --noproject Bypass check of sfdx-project.json to
exist
-p, --sourcepath=sourcepath Path where to watch data
-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
EXAMPLE
sfdx veloce:debug:watch --targetusername [email protected] --targetdevhubusername [email protected] --sourcepath
source/models
See code: src/commands/veloce/debug/watch.ts
sfdx veloce:fixref3 [-d] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
Fix sobjects external id if empty
USAGE
$ sfdx veloce:fixref3 [-d] [-u <string>] [--apiversion <string>] [--json] [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
OPTIONS
-d, --dry Performs dry run and won't change
org data
-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 veloce:fixref --targetusername [email protected] --targetdevhubusername [email protected] --dry
sfdx veloce:fixref --targetusername [email protected] --targetdevhubusername [email protected]
See code: src/commands/veloce/fixref3.ts
sfdx veloce:login -p <string> -a <string> -u <string> -r <string> [-s <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
Login using username and password
USAGE
$ sfdx veloce:login -p <string> -a <string> -u <string> -r <string> [-s <string>] [--json] [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
OPTIONS
-a, --alias=alias (required) target alias to create
-p, --passwordfile=passwordfile (required) Relative/Full path to
file containing password
-r, --instanceurl=instanceurl (required) salesforce environment
Instance URL
-s, --securitytoken=securitytoken security token
-u, --user=user (required) Username to login with
--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 veloce:login -u username -p ./PASSWORDFILE -a alias01
See code: src/commands/veloce/login.ts
sfdx veloce:source:pack -m <string> [-p <string>] [-o <string>] [-I <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
Builds and returns sources
USAGE
$ sfdx veloce:source:pack -m <string> [-p <string>] [-o <string>] [-I <string>] [--json] [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
OPTIONS
-I, --idmap=idmap idmap.json file path
-m, --members=members (required) Pack specific type of
data
-o, --outputpath=outputpath Path where to put compiled sources
-p, --sourcepath=sourcepath Path where to get sources
--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 veloce:source:pack --targetusername [email protected] --targetdevhubusername [email protected] --members
config-ui:OCTA --sourcepath ./source/config-ui --outputpath ./out/
See code: src/commands/veloce/source/pack.ts
sfdx veloce:source:pull [-m <string>] [-p <string>] [-P] [-I <string>] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
Retrieves Sources from Salesforce org and stores it in git folder structure
USAGE
$ sfdx veloce:source:pull [-m <string>] [-p <string>] [-P] [-I <string>] [-v <string>] [-u <string>] [--apiversion
<string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
OPTIONS
-I, --idmap=idmap idmap.json file path
-P, --noproject Bypass check of sfdx-project.json to
exist
-m, --members=members Pull only specific type of data or
even name of object
-p, --sourcepath=sourcepath Path where to store sources
-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
EXAMPLE
sfdx veloce:source:pull --targetusername [email protected] --targetdevhubusername [email protected] --members model:OCTA
--sourcepath ./source/pmls
See code: src/commands/veloce/source/pull.ts
sfdx veloce:source:push [-m <string>] [-p <string>] [-P] [-d] [-I <string>] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
Uploads Sources to Salesforce org from git folder structure
USAGE
$ sfdx veloce:source:push [-m <string>] [-p <string>] [-P] [-d] [-I <string>] [-v <string>] [-u <string>]
[--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
OPTIONS
-I, --idmap=idmap idmap.json file path
-P, --noproject Bypass check of sfdx-project.json to
exist
-d, --skipdelete Only for upload, skip db clean up
-m, --members=members Push only specific type of data or
even name of object
-p, --sourcepath=sourcepath Path where to get sources
-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
EXAMPLE
sfdx veloce:source:push --targetusername [email protected] --targetdevhubusername [email protected] --members model:OCTA
--sourcepath ./source/models
See code: src/commands/veloce/source/push.ts