veloce

Extension to sfdx which allows veloce specific data pull and push

![Version](https://npmjs.org/package/veloce-sfdx-v3)
![Tests](https://github.com/veloceapps/veloce-sfdx-v3/actions/workflows/unit-tests.yml)
![Greenkeeper](https://greenkeeper.io/)
![Known Vulnerabilities](https://snyk.io/test/github/veloceapps/veloce-sfdx-v3)
![Downloads/week](https://npmjs.org/package/veloce-sfdx-v3)
![License](https://github.com/veloceapps/veloce-sfdx-v3/blob/master/package.json)

sfdx veloce:data:pull [-m ] [-w ] [-s ] [-p ] [-o ] [-R ] [-v ] [-u ] [--apiversion ] [--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

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

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_

sfdx veloce:data:push [-m ] [-p ] [-P] [-s ] [-e ] [-R ] [-P] [-U] [-d] [-D] [-o ] [-b ] [-v ] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

Uploads Data from CSVs to Salesforce org

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

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_

sfdx veloce:debug:list [-P] [-v ] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

Lists debug sessions

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

EXAMPLE sfdx veloce:debug:list --targetusername myOrg@example.com --targetdevhubusername devhub@org.com`

_See code: src/commands/veloce/debug/list.ts_

sfdx veloce:debug:logs [-P] [-l debug|info|warn|error|DEBUG|INFO|WARN|ERROR] [-v ] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

Streams logs out of debug session to console

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

EXAMPLE sfdx veloce:debug:logs --targetusername myOrg@example.com --targetdevhubusername devhub@org.com --debugsessionloglevel warn`

_See code: src/commands/veloce/debug/logs.ts_

sfdx veloce:debug:push -m [-p ] [-P] [-v ] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

Pushes changes to debug session manually

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

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_

sfdx veloce:debug:start [-P] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

Starts new ISOLATED debug session

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

EXAMPLE sfdx veloce:debug:start --targetusername myOrg@example.com --targetdevhubusername devhub@org.com`

_See code: src/commands/veloce/debug/start.ts_

sfdx veloce:debug:stop [-P] [--dev-token ] [-v ] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

Stops debug session

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

EXAMPLE sfdx veloce:debug:stop --targetusername myOrg@example.com --targetdevhubusername devhub@org.com`

_See code: src/commands/veloce/debug/stop.ts_

sfdx veloce:debug:watch [-p ] [-P] [-v ] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

Watches filesystem for changes and automatically propagates them to backend

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

EXAMPLE sfdx veloce:debug:watch --targetusername myOrg@example.com --targetdevhubusername devhub@org.com --sourcepath source/models`

_See code: src/commands/veloce/debug/watch.ts_

sfdx veloce:fixref3 [-d] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

Fix sobjects external id if empty

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

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_

sfdx veloce:login -p -a -u -r [-s ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

Login using username and password

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

EXAMPLE $ sfdx veloce:login -u username -p ./PASSWORDFILE -a alias01`

_See code: src/commands/veloce/login.ts_

sfdx veloce:source:pack -m [-p ] [-o ] [-I ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

Builds and returns sources

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

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_

sfdx veloce:source:pack-v2 -m [-p ] [-o ] [-I ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

Builds and returns sources

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

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_

sfdx veloce:source:pull [-m ] [-p ] [-P] [-I ] [-v ] [-u ] [--apiversion ] [--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

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

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_

sfdx veloce:source:push [-m ] [-p ] [-P] [-d] [-I ] [-v ] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

Uploads Sources to Salesforce org from git folder structure

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

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_