Extension to sfdx which allows veloce specific data pull and push
npm install veloce-sfdx-v3Extension to sfdx which allows veloce specific data pull and push






* veloce
``sh-session`
$ npm install -g veloce-sfdx-v3
$ sfdx COMMAND
running command...
$ sfdx (-v|--version|version)
veloce-sfdx-v3/0.0.42 darwin-x64 node-v22.17.1
$ sfdx --help [COMMAND]
USAGE
$ sfdx COMMAND
...sfdx veloce:data:pull [-m
* [](#sfdx-velocedatapull--m-string--w-string--s-string--p-string--o-string--r-string--v-string--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)sfdx veloce:data:push [-m
* [](#sfdx-velocedatapush--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-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)sfdx veloce:debug:list [-P] [-v
* [](#sfdx-velocedebuglist--p--v-string--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)sfdx veloce:debug:logs [-P] [-l debug|info|warn|error|DEBUG|INFO|WARN|ERROR] [-v
* [](#sfdx-velocedebuglogs--p--l-debuginfowarnerrordebuginfowarnerror--v-string--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)sfdx veloce:debug:push -m
* [](#sfdx-velocedebugpush--m-string--p-string--p--v-string--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)sfdx veloce:debug:start [-P] [-u
* [](#sfdx-velocedebugstart--p--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)sfdx veloce:debug:stop [-P] [--dev-token
* [](#sfdx-velocedebugstop--p---dev-token-string--v-string--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)sfdx veloce:debug:watch [-p
* [](#sfdx-velocedebugwatch--p-string--p--v-string--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)sfdx veloce:fixref3 [-d] [-u
* [](#sfdx-velocefixref3--d--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)sfdx veloce:login -p
* [](#sfdx-velocelogin--p-string--a-string--u-string--r-string--s-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)sfdx veloce:source:pack -m
* [](#sfdx-velocesourcepack--m-string--p-string--o-string--i-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)sfdx veloce:source:pack-v2 -m
* [](#sfdx-velocesourcepack-v2--m-string--p-string--o-string--i-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)sfdx veloce:source:pull [-m
* [](#sfdx-velocesourcepull--m-string--p-string--p--i-string--v-string--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)sfdx veloce:source:push [-m
* [](#sfdx-velocesourcepush--m-string--p-string--p--d--i-string--v-string--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
Retrieves data from Salesforce org and stores it in provided folder as CSVs
`
USAGE
$ sfdx veloce:data:pull [-m
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 myOrg@example.com --targetdevhubusername devhub@org.com --sourcepath
./source/templates
sfdx veloce:data:pull --targetusername myOrg@example.com --targetdevhubusername devhub@org.com --sourcepath
./source/templates --members price-list:OctaPriceListName
`
_See code: src/commands/veloce/data/pull.ts_
Uploads Data from CSVs to Salesforce org
`
USAGE
$ sfdx veloce:data:push [-m
[-o
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 myOrg@example.com --targetdevhubusername devhub@org.com --members model:Octa
--sourcepath ./source/templates
`
_See code: src/commands/veloce/data/push.ts_
Lists debug sessions
`
USAGE
$ sfdx veloce:debug:list [-P] [-v
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 myOrg@example.com --targetdevhubusername devhub@org.com
`
_See code: src/commands/veloce/debug/list.ts_
Streams logs out of debug session to console
`
USAGE
$ sfdx veloce:debug:logs [-P] [-l debug|info|warn|error|DEBUG|INFO|WARN|ERROR] [-v
[--apiversion
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 myOrg@example.com --targetdevhubusername devhub@org.com --debugsessionloglevel
warn
`
_See code: src/commands/veloce/debug/logs.ts_
Pushes changes to debug session manually
`
USAGE
$ sfdx veloce:debug:push -m
[--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 myOrg@example.com --targetdevhubusername devhub@org.com
sfdx veloce:debug:push --targetusername myOrg@example.com --targetdevhubusername devhub@org.com -m
model:name_of_my_model -p ./source/my-alternative-model-folder
`
_See code: src/commands/veloce/debug/push.ts_
Starts new ISOLATED debug session
`
USAGE
$ sfdx veloce:debug:start [-P] [-u
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 myOrg@example.com --targetdevhubusername devhub@org.com
`
_See code: src/commands/veloce/debug/start.ts_
Stops debug session
`
USAGE
$ sfdx veloce:debug:stop [-P] [--dev-token
[--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 myOrg@example.com --targetdevhubusername devhub@org.com
`
_See code: src/commands/veloce/debug/stop.ts_
Watches filesystem for changes and automatically propagates them to backend
`
USAGE
$ sfdx veloce:debug:watch [-p
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 myOrg@example.com --targetdevhubusername devhub@org.com --sourcepath
source/models
`
_See code: src/commands/veloce/debug/watch.ts_
Fix sobjects external id if empty
`
USAGE
$ sfdx veloce:fixref3 [-d] [-u
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 myOrg@example.com --targetdevhubusername devhub@org.com --dry
sfdx veloce:fixref --targetusername myOrg@example.com --targetdevhubusername devhub@org.com
`
_See code: src/commands/veloce/fixref3.ts_
Login using username and password
`
USAGE
$ sfdx veloce:login -p
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_
Builds and returns sources
`
USAGE
$ sfdx veloce:source:pack -m
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 myOrg@example.com --targetdevhubusername devhub@org.com --members
config-ui:OCTA --sourcepath ./source/config-ui --outputpath ./out/
`
_See code: src/commands/veloce/source/pack.ts_
Builds and returns sources
`
USAGE
$ sfdx veloce:source:pack-v2 -m
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 myOrg@example.com --targetdevhubusername devhub@org.com --members
config-ui:OCTA --sourcepath ./source/config-ui --outputpath ./out/
`
_See code: src/commands/veloce/source/pack-v2.ts_
Retrieves Sources from Salesforce org and stores it in git folder structure
`
USAGE
$ sfdx veloce:source:pull [-m
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 myOrg@example.com --targetdevhubusername devhub@org.com --members model:OCTA
--sourcepath ./source/pmls
`
_See code: src/commands/veloce/source/pull.ts_
Uploads Sources to Salesforce org from git folder structure
`
USAGE
$ sfdx veloce:source:push [-m
[--apiversion
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 myOrg@example.com --targetdevhubusername devhub@org.com --members model:OCTA
--sourcepath ./source/models
``
_See code: src/commands/veloce/source/push.ts_