@kitalive/sfdx-plugin 0.4.6 → 0.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (55) hide show
  1. package/README.md +317 -443
  2. package/lib/bulk.js +161 -167
  3. package/lib/bulk.js.map +1 -1
  4. package/lib/commands/kit/data/bulk/delete.js +45 -38
  5. package/lib/commands/kit/data/bulk/delete.js.map +1 -1
  6. package/lib/commands/kit/data/bulk/query.js +25 -23
  7. package/lib/commands/kit/data/bulk/query.js.map +1 -1
  8. package/lib/commands/kit/data/bulk/upsert.js +13 -1
  9. package/lib/commands/kit/data/bulk/upsert.js.map +1 -1
  10. package/lib/commands/kit/data/csv/convert.js +43 -36
  11. package/lib/commands/kit/data/csv/convert.js.map +1 -1
  12. package/lib/commands/kit/layout/assignments/deploy.js +20 -18
  13. package/lib/commands/kit/layout/assignments/deploy.js.map +1 -1
  14. package/lib/commands/kit/layout/assignments/retrieve.js +52 -47
  15. package/lib/commands/kit/layout/assignments/retrieve.js.map +1 -1
  16. package/lib/commands/kit/object/fields/describe.js +23 -23
  17. package/lib/commands/kit/object/fields/describe.js.map +1 -1
  18. package/lib/commands/kit/object/fields/setup.js +69 -65
  19. package/lib/commands/kit/object/fields/setup.js.map +1 -1
  20. package/lib/commands/kit/script/execute.js +34 -43
  21. package/lib/commands/kit/script/execute.js.map +1 -1
  22. package/lib/index.js +1 -2
  23. package/lib/index.js.map +1 -1
  24. package/lib/metadata.js +4 -2
  25. package/lib/metadata.js.map +1 -1
  26. package/lib/utils.js +6 -5
  27. package/lib/utils.js.map +1 -1
  28. package/messages/data.bulk.delete.md +17 -0
  29. package/messages/data.bulk.md +54 -0
  30. package/messages/data.bulk.query.md +17 -0
  31. package/messages/data.bulk.upsert.md +13 -0
  32. package/messages/data.csv.convert.md +49 -0
  33. package/messages/layout.assignments.deploy.md +24 -0
  34. package/messages/layout.assignments.retrieve.md +46 -0
  35. package/messages/object.fields.describe.md +25 -0
  36. package/messages/object.fields.setup.md +29 -0
  37. package/messages/script.execute.md +42 -0
  38. package/oclif.manifest.json +1017 -1
  39. package/package.json +162 -49
  40. package/lib/bulk.d.ts +0 -22
  41. package/lib/commands/kit/data/bulk/delete.d.ts +0 -18
  42. package/lib/commands/kit/data/bulk/insert.d.ts +0 -2
  43. package/lib/commands/kit/data/bulk/query.d.ts +0 -15
  44. package/lib/commands/kit/data/bulk/update.d.ts +0 -2
  45. package/lib/commands/kit/data/bulk/upsert.d.ts +0 -2
  46. package/lib/commands/kit/data/csv/convert.d.ts +0 -22
  47. package/lib/commands/kit/layout/assignments/deploy.d.ts +0 -13
  48. package/lib/commands/kit/layout/assignments/retrieve.d.ts +0 -21
  49. package/lib/commands/kit/object/fields/describe.d.ts +0 -14
  50. package/lib/commands/kit/object/fields/setup.d.ts +0 -21
  51. package/lib/commands/kit/script/execute.d.ts +0 -13
  52. package/lib/index.d.ts +0 -2
  53. package/lib/metadata.d.ts +0 -18
  54. package/lib/types.d.ts +0 -35
  55. package/lib/utils.d.ts +0 -16
@@ -1 +1,1017 @@
1
- {"version":"0.4.6","commands":{"kit:script:execute":{"id":"kit:script:execute","description":"execute Node.js scripts in SfdxCommand context\nAvailable variables in Node.js scripts\n argv: Parsed command line arguments after the file option\n conn: jsforce Connection\n context: SfdxCommand","usage":"<%= command.id %> [-f <filepath>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]","pluginName":"@kitalive/sfdx-plugin","pluginType":"core","aliases":["kit:script"],"examples":["$ sfdx kit:script -f ./path/to/script.js","$ sfdx kit:script:execute","> await conn.query('SELECT Id, Name FROM Account LIMIT 1')","Top level await is not enabled by default in REPL before Node.js v16","$ NODE_OPTIONS=--experimental-repl-await sfdx kit:script:execute"],"flags":{"json":{"name":"json","type":"boolean","description":"format output as json","allowNo":false},"loglevel":{"name":"loglevel","type":"option","description":"logging level for this command invocation","required":false,"helpValue":"(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)","options":["trace","debug","info","warn","error","fatal","TRACE","DEBUG","INFO","WARN","ERROR","FATAL"],"default":"warn"},"targetusername":{"name":"targetusername","type":"option","char":"u","description":"username or alias for the target org; overrides default target org"},"apiversion":{"name":"apiversion","type":"option","description":"override the api version used for api requests made by this command"},"file":{"name":"file","type":"option","char":"f","description":"the path of the Node.js script file to execute"}},"args":[]},"kit:data:bulk:delete":{"id":"kit:data:bulk:delete","description":"bulk delete records by SOQL select query","usage":"<%= command.id %> -q <string> [--hard] [--concurrencymode <string>] [-s <integer>] [-w <integer>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]","pluginName":"@kitalive/sfdx-plugin","pluginType":"core","aliases":[],"examples":["$ sfdx kit:data:bulk:delete -q 'SELECT Id FROM Opportunity WHERE CloseDate < LAST_N_YEARS:5'"],"flags":{"json":{"name":"json","type":"boolean","description":"format output as json","allowNo":false},"loglevel":{"name":"loglevel","type":"option","description":"logging level for this command invocation","required":false,"helpValue":"(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)","options":["trace","debug","info","warn","error","fatal","TRACE","DEBUG","INFO","WARN","ERROR","FATAL"],"default":"warn"},"targetusername":{"name":"targetusername","type":"option","char":"u","description":"username or alias for the target org; overrides default target org"},"apiversion":{"name":"apiversion","type":"option","description":"override the api version used for api requests made by this command"},"query":{"name":"query","type":"option","char":"q","description":"SOQL query to delete","required":true},"hard":{"name":"hard","type":"boolean","description":"perform a hard delete","allowNo":false},"concurrencymode":{"name":"concurrencymode","type":"option","description":"the concurrency mode (Parallel or Serial) for the job","default":"Parallel"},"batchsize":{"name":"batchsize","type":"option","char":"s","description":"the batch size of the job","default":10000},"wait":{"name":"wait","type":"option","char":"w","description":"the number of minutes to wait for the command to complete before displaying the results"}},"args":[]},"kit:data:bulk:insert":{"id":"kit:data:bulk:insert","description":"bulk insert records from a CSV file\nFor information about CSV file formats, see [Prepare CSV Files](https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/datafiles_csv_preparing.htm) in the Bulk API Developer Guide.","usage":"<%= command.id %> -o <string> -f <filepath> [-r <filepath>] [-e <string>] [-d <string>] [-q <string>] [--skiplines <integer>] [--trim] [-m <filepath>] [-c <filepath>] [--setnull] [--convertonly] [--concurrencymode <string>] [--assignmentruleid <string>] [-s <integer>] [-w <integer>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]","pluginName":"@kitalive/sfdx-plugin","pluginType":"core","aliases":[],"examples":["$ sfdx kit:data:bulk:insert -o Account -f ./path/to/Account.csv -m ./path/to/mapping.json","$ sfdx kit:data:bulk:insert -o MyObject__c -f ./path/to/MyObject__c.csv -c ./path/to/convert.js -w 10"],"flags":{"json":{"name":"json","type":"boolean","description":"format output as json","allowNo":false},"loglevel":{"name":"loglevel","type":"option","description":"logging level for this command invocation","required":false,"helpValue":"(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)","options":["trace","debug","info","warn","error","fatal","TRACE","DEBUG","INFO","WARN","ERROR","FATAL"],"default":"warn"},"targetusername":{"name":"targetusername","type":"option","char":"u","description":"username or alias for the target org; overrides default target org"},"apiversion":{"name":"apiversion","type":"option","description":"override the api version used for api requests made by this command"},"object":{"name":"object","type":"option","char":"o","description":"the sObject name to insert","required":true},"csvfile":{"name":"csvfile","type":"option","char":"f","description":"the CSV file path that defines the records to insert","required":true},"resultfile":{"name":"resultfile","type":"option","char":"r","description":"the CSV file path for writing the insert results"},"encoding":{"name":"encoding","type":"option","char":"e","description":"the input CSV file encoding","default":"utf8"},"delimiter":{"name":"delimiter","type":"option","char":"d","description":"the input CSV file delimiter","default":","},"quote":{"name":"quote","type":"option","char":"q","description":"the input CSV file quote character","default":"\""},"skiplines":{"name":"skiplines","type":"option","description":"the number of lines to skip","default":0},"trim":{"name":"trim","type":"boolean","description":"trim all white space from columns","allowNo":false},"mapping":{"name":"mapping","type":"option","char":"m","description":"the path of the JSON file that defines CSV column mappings"},"converter":{"name":"converter","type":"option","char":"c","description":"the path of the script to convert CSV rows"},"setnull":{"name":"setnull","type":"boolean","description":"set blank values as null values during insert operations (default: empty field values are ignored)","allowNo":false},"convertonly":{"name":"convertonly","type":"boolean","description":"output converted.csv file and skip insert for debugging","allowNo":false},"concurrencymode":{"name":"concurrencymode","type":"option","description":"the concurrency mode (Parallel or Serial) for the job","default":"Parallel"},"assignmentruleid":{"name":"assignmentruleid","type":"option","description":"the ID of a specific assignment rule to run for a case or a lead."},"batchsize":{"name":"batchsize","type":"option","char":"s","description":"the batch size of the job","default":10000},"wait":{"name":"wait","type":"option","char":"w","description":"the number of minutes to wait for the command to complete before displaying the results"}},"args":[]},"kit:data:bulk:query":{"id":"kit:data:bulk:query","description":"bulk query records","usage":"<%= command.id %> -q <string> [-f <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]","pluginName":"@kitalive/sfdx-plugin","pluginType":"core","aliases":[],"examples":["$ sfdx kit:data:bulk:query -q 'SELECT Id, Name FROM Account' -f ./path/to/Account.csv"],"flags":{"json":{"name":"json","type":"boolean","description":"format output as json","allowNo":false},"loglevel":{"name":"loglevel","type":"option","description":"logging level for this command invocation","required":false,"helpValue":"(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)","options":["trace","debug","info","warn","error","fatal","TRACE","DEBUG","INFO","WARN","ERROR","FATAL"],"default":"warn"},"targetusername":{"name":"targetusername","type":"option","char":"u","description":"username or alias for the target org; overrides default target org"},"apiversion":{"name":"apiversion","type":"option","description":"override the api version used for api requests made by this command"},"query":{"name":"query","type":"option","char":"q","description":"SOQL query to export","required":true},"csvfile":{"name":"csvfile","type":"option","char":"f","description":"output csv file (default: standard output)"}},"args":[]},"kit:data:bulk:update":{"id":"kit:data:bulk:update","description":"bulk update records from a CSV file\nFor information about CSV file formats, see [Prepare CSV Files](https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/datafiles_csv_preparing.htm) in the Bulk API Developer Guide.","usage":"<%= command.id %> -o <string> -f <filepath> [-r <filepath>] [-e <string>] [-d <string>] [-q <string>] [--skiplines <integer>] [--trim] [-m <filepath>] [-c <filepath>] [--setnull] [--convertonly] [--concurrencymode <string>] [--assignmentruleid <string>] [-s <integer>] [-w <integer>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]","pluginName":"@kitalive/sfdx-plugin","pluginType":"core","aliases":[],"examples":["$ sfdx kit:data:bulk:update -o Account -f ./path/to/Account.csv -m ./path/to/mapping.json","$ sfdx kit:data:bulk:update -o MyObject__c -f ./path/to/MyObject__c.csv -c ./path/to/convert.js -w 10"],"flags":{"json":{"name":"json","type":"boolean","description":"format output as json","allowNo":false},"loglevel":{"name":"loglevel","type":"option","description":"logging level for this command invocation","required":false,"helpValue":"(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)","options":["trace","debug","info","warn","error","fatal","TRACE","DEBUG","INFO","WARN","ERROR","FATAL"],"default":"warn"},"targetusername":{"name":"targetusername","type":"option","char":"u","description":"username or alias for the target org; overrides default target org"},"apiversion":{"name":"apiversion","type":"option","description":"override the api version used for api requests made by this command"},"object":{"name":"object","type":"option","char":"o","description":"the sObject name to update","required":true},"csvfile":{"name":"csvfile","type":"option","char":"f","description":"the CSV file path that defines the records to update","required":true},"resultfile":{"name":"resultfile","type":"option","char":"r","description":"the CSV file path for writing the update results"},"encoding":{"name":"encoding","type":"option","char":"e","description":"the input CSV file encoding","default":"utf8"},"delimiter":{"name":"delimiter","type":"option","char":"d","description":"the input CSV file delimiter","default":","},"quote":{"name":"quote","type":"option","char":"q","description":"the input CSV file quote character","default":"\""},"skiplines":{"name":"skiplines","type":"option","description":"the number of lines to skip","default":0},"trim":{"name":"trim","type":"boolean","description":"trim all white space from columns","allowNo":false},"mapping":{"name":"mapping","type":"option","char":"m","description":"the path of the JSON file that defines CSV column mappings"},"converter":{"name":"converter","type":"option","char":"c","description":"the path of the script to convert CSV rows"},"setnull":{"name":"setnull","type":"boolean","description":"set blank values as null values during update operations (default: empty field values are ignored)","allowNo":false},"convertonly":{"name":"convertonly","type":"boolean","description":"output converted.csv file and skip update for debugging","allowNo":false},"concurrencymode":{"name":"concurrencymode","type":"option","description":"the concurrency mode (Parallel or Serial) for the job","default":"Parallel"},"assignmentruleid":{"name":"assignmentruleid","type":"option","description":"the ID of a specific assignment rule to run for a case or a lead."},"batchsize":{"name":"batchsize","type":"option","char":"s","description":"the batch size of the job","default":10000},"wait":{"name":"wait","type":"option","char":"w","description":"the number of minutes to wait for the command to complete before displaying the results"}},"args":[]},"kit:data:bulk:upsert":{"id":"kit:data:bulk:upsert","description":"bulk upsert records from a CSV file\nFor information about CSV file formats, see [Prepare CSV Files](https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/datafiles_csv_preparing.htm) in the Bulk API Developer Guide.","usage":"<%= command.id %> -o <string> -f <filepath> -i <string> [-r <filepath>] [-e <string>] [-d <string>] [-q <string>] [--skiplines <integer>] [--trim] [-m <filepath>] [-c <filepath>] [--setnull] [--convertonly] [--concurrencymode <string>] [--assignmentruleid <string>] [-s <integer>] [-w <integer>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]","pluginName":"@kitalive/sfdx-plugin","pluginType":"core","aliases":[],"examples":["$ sfdx kit:data:bulk:upsert -o Account -f ./path/to/Account.csv -m ./path/to/mapping.json","$ sfdx kit:data:bulk:upsert -o MyObject__c -f ./path/to/MyObject__c.csv -c ./path/to/convert.js -i MyExternalId__c -w 10"],"flags":{"json":{"name":"json","type":"boolean","description":"format output as json","allowNo":false},"loglevel":{"name":"loglevel","type":"option","description":"logging level for this command invocation","required":false,"helpValue":"(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)","options":["trace","debug","info","warn","error","fatal","TRACE","DEBUG","INFO","WARN","ERROR","FATAL"],"default":"warn"},"targetusername":{"name":"targetusername","type":"option","char":"u","description":"username or alias for the target org; overrides default target org"},"apiversion":{"name":"apiversion","type":"option","description":"override the api version used for api requests made by this command"},"object":{"name":"object","type":"option","char":"o","description":"the sObject name to upsert","required":true},"csvfile":{"name":"csvfile","type":"option","char":"f","description":"the CSV file path that defines the records to upsert","required":true},"resultfile":{"name":"resultfile","type":"option","char":"r","description":"the CSV file path for writing the upsert results"},"encoding":{"name":"encoding","type":"option","char":"e","description":"the input CSV file encoding","default":"utf8"},"delimiter":{"name":"delimiter","type":"option","char":"d","description":"the input CSV file delimiter","default":","},"quote":{"name":"quote","type":"option","char":"q","description":"the input CSV file quote character","default":"\""},"skiplines":{"name":"skiplines","type":"option","description":"the number of lines to skip","default":0},"trim":{"name":"trim","type":"boolean","description":"trim all white space from columns","allowNo":false},"mapping":{"name":"mapping","type":"option","char":"m","description":"the path of the JSON file that defines CSV column mappings"},"converter":{"name":"converter","type":"option","char":"c","description":"the path of the script to convert CSV rows"},"setnull":{"name":"setnull","type":"boolean","description":"set blank values as null values during upsert operations (default: empty field values are ignored)","allowNo":false},"convertonly":{"name":"convertonly","type":"boolean","description":"output converted.csv file and skip upsert for debugging","allowNo":false},"concurrencymode":{"name":"concurrencymode","type":"option","description":"the concurrency mode (Parallel or Serial) for the job","default":"Parallel"},"assignmentruleid":{"name":"assignmentruleid","type":"option","description":"the ID of a specific assignment rule to run for a case or a lead."},"batchsize":{"name":"batchsize","type":"option","char":"s","description":"the batch size of the job","default":10000},"wait":{"name":"wait","type":"option","char":"w","description":"the number of minutes to wait for the command to complete before displaying the results"},"externalid":{"name":"externalid","type":"option","char":"i","description":"the column name of the external ID","required":true,"default":"Id"}},"args":[]},"kit:data:csv:convert":{"id":"kit:data:csv:convert","description":"convert CSV data using column mapping file or Node.js script","usage":"<%= command.id %> [-f <filepath>] [-o <filepath>] [-e <string>] [-d <string>] [-q <string>] [--skiplines <integer>] [--trim] [-m <filepath>] [-c <filepath>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]","pluginName":"@kitalive/sfdx-plugin","pluginType":"core","aliases":[],"examples":["$ sfdx kit:data:csv:convert -f ./path/to/input.csv -m ./path/to/mapping.json","$ sfdx kit:data:csv:convert -f ./path/to/input.csv -o ./path/to/output.csv -c ./path/to/convert.js -e cp932 -d :"],"flags":{"json":{"name":"json","type":"boolean","description":"format output as json","allowNo":false},"loglevel":{"name":"loglevel","type":"option","description":"logging level for this command invocation","required":false,"helpValue":"(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)","options":["trace","debug","info","warn","error","fatal","TRACE","DEBUG","INFO","WARN","ERROR","FATAL"],"default":"warn"},"inputfile":{"name":"inputfile","type":"option","char":"f","description":"the path of the input CSV file (default: standard input)"},"outputfile":{"name":"outputfile","type":"option","char":"o","description":"the path of the output CSV file (default: standard output)"},"encoding":{"name":"encoding","type":"option","char":"e","description":"the input CSV file encoding","default":"utf8"},"delimiter":{"name":"delimiter","type":"option","char":"d","description":"the input CSV file delimiter","default":","},"quote":{"name":"quote","type":"option","char":"q","description":"the input CSV file quote character","default":"\""},"skiplines":{"name":"skiplines","type":"option","description":"the number of lines to skip","default":0},"trim":{"name":"trim","type":"boolean","description":"trim all white space from columns","allowNo":false},"mapping":{"name":"mapping","type":"option","char":"m","description":"the path of the JSON file that defines CSV column mappings"},"converter":{"name":"converter","type":"option","char":"c","description":"the path of the script to convert CSV rows"}},"args":[]},"kit:layout:assignments:deploy":{"id":"kit:layout:assignments:deploy","description":"deploy page layout assignments from JSON file","usage":"<%= command.id %> -f <string> [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]","pluginName":"@kitalive/sfdx-plugin","pluginType":"core","aliases":[],"examples":["$ sfdx kit:layout:assignments:deploy","$ sfdx kit:layout:assignments:deploy -f config/layout-assignments.scratch.json","$ sfdx kit:layout:assignments:deploy -u me@my.org -f config/layout-assignments.sandbox.json"],"flags":{"json":{"name":"json","type":"boolean","description":"format output as json","allowNo":false},"loglevel":{"name":"loglevel","type":"option","description":"logging level for this command invocation","required":false,"helpValue":"(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)","options":["trace","debug","info","warn","error","fatal","TRACE","DEBUG","INFO","WARN","ERROR","FATAL"],"default":"warn"},"targetusername":{"name":"targetusername","type":"option","char":"u","description":"username or alias for the target org; overrides default target org"},"apiversion":{"name":"apiversion","type":"option","description":"override the api version used for api requests made by this command"},"file":{"name":"file","type":"option","char":"f","description":"input file path","required":true,"default":"config/layout-assignments.json"}},"args":[]},"kit:layout:assignments:retrieve":{"id":"kit:layout:assignments:retrieve","description":"retrieve page layout assignments and save to JSON file","usage":"<%= command.id %> -f <string> [-p <string>] [-o <string>] [--merge] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]","pluginName":"@kitalive/sfdx-plugin","pluginType":"core","aliases":[],"examples":["$ sfdx kit:layout:assignments:retrieve","$ sfdx kit:layout:assignments:retrieve -p Admin,Standard,StandardAul -o Account,CustomObject__c -f config/layout-assignments.scratch.json","$ sfdx kit:layout:assignments:retrieve -u me@my.org -f config/layout-assignments.sandbox.json"],"flags":{"json":{"name":"json","type":"boolean","description":"format output as json","allowNo":false},"loglevel":{"name":"loglevel","type":"option","description":"logging level for this command invocation","required":false,"helpValue":"(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)","options":["trace","debug","info","warn","error","fatal","TRACE","DEBUG","INFO","WARN","ERROR","FATAL"],"default":"warn"},"targetusername":{"name":"targetusername","type":"option","char":"u","description":"username or alias for the target org; overrides default target org"},"apiversion":{"name":"apiversion","type":"option","description":"override the api version used for api requests made by this command"},"file":{"name":"file","type":"option","char":"f","description":"output file path","required":true,"default":"config/layout-assignments.json"},"profile":{"name":"profile","type":"option","char":"p","description":"comma separated profile names to retrieve (default: all profiles)","required":false},"object":{"name":"object","type":"option","char":"o","description":"comma separated object names to retrieve (default: objects which have multiple layouts)","required":false},"merge":{"name":"merge","type":"boolean","description":"merge retrieved configurations with existing file","required":false,"allowNo":false}},"args":[]},"kit:object:fields:describe":{"id":"kit:object:fields:describe","description":"describe object fields information","usage":"<%= command.id %> -o <string> [-f <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]","pluginName":"@kitalive/sfdx-plugin","pluginType":"core","aliases":[],"examples":["$ sfdx kit:object:fields:describe -o Account -f path/to/account_fields.csv","$ sfdx kit:object:fields:describe -u me@my.org -o CustomObject__c --json"],"flags":{"json":{"name":"json","type":"boolean","description":"format output as json","allowNo":false},"loglevel":{"name":"loglevel","type":"option","description":"logging level for this command invocation","required":false,"helpValue":"(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)","options":["trace","debug","info","warn","error","fatal","TRACE","DEBUG","INFO","WARN","ERROR","FATAL"],"default":"warn"},"targetusername":{"name":"targetusername","type":"option","char":"u","description":"username or alias for the target org; overrides default target org"},"apiversion":{"name":"apiversion","type":"option","description":"override the api version used for api requests made by this command"},"object":{"name":"object","type":"option","char":"o","description":"SObject name","required":true},"file":{"name":"file","type":"option","char":"f","description":"output csv file path"}},"args":[]},"kit:object:fields:setup":{"id":"kit:object:fields:setup","description":"upsert and delete object fields from a CSV file","usage":"<%= command.id %> -o <string> -f <string> [--delete] [--force] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]","pluginName":"@kitalive/sfdx-plugin","pluginType":"core","aliases":[],"examples":["$ sfdx kit:object:fields:setup -o Account -f path/to/account_fields.csv","$ sfdx kit:object:fields:setup -u me@my.org -o CustomObject__c -f path/to/custom_object_fields.csv --delete"],"flags":{"json":{"name":"json","type":"boolean","description":"format output as json","allowNo":false},"loglevel":{"name":"loglevel","type":"option","description":"logging level for this command invocation","required":false,"helpValue":"(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)","options":["trace","debug","info","warn","error","fatal","TRACE","DEBUG","INFO","WARN","ERROR","FATAL"],"default":"warn"},"targetusername":{"name":"targetusername","type":"option","char":"u","description":"username or alias for the target org; overrides default target org"},"apiversion":{"name":"apiversion","type":"option","description":"override the api version used for api requests made by this command"},"object":{"name":"object","type":"option","char":"o","description":"SObject name","required":true},"file":{"name":"file","type":"option","char":"f","description":"input csv file path","required":true},"delete":{"name":"delete","type":"boolean","description":"delete fields that are not in the csv file","allowNo":false},"force":{"name":"force","type":"boolean","description":"Do not confirm when deleting","allowNo":false}},"args":[]}}}
1
+ {
2
+ "version": "0.5.0",
3
+ "commands": {
4
+ "kit:script:execute": {
5
+ "id": "kit:script:execute",
6
+ "summary": "Execute Node.js scripts in SfCommand context.",
7
+ "description": "Available variables in Node.js scripts\n\n- argv: Parsed command line arguments after the file option\n- conn: jsforce Connection\n- context: SfCommand",
8
+ "strict": false,
9
+ "pluginName": "@kitalive/sfdx-plugin",
10
+ "pluginAlias": "@kitalive/sfdx-plugin",
11
+ "pluginType": "core",
12
+ "aliases": [
13
+ "kit:script"
14
+ ],
15
+ "examples": [
16
+ "Execute from js file:\n<%= config.bin %> <%= command.id %> -f ./path/to/script.js",
17
+ "Execute in REPL mode:\n<%= config.bin %> <%= command.id %> -o target-org",
18
+ "query a account from org in REPL\n> await conn.query('SELECT Id, Name FROM Account LIMIT 1')\nTop level await is not enabled by default in REPL before Node.js v16\n$ NODE_OPTIONS=--experimental-repl-await <%= config.bin %> <%= command.id %>"
19
+ ],
20
+ "flags": {
21
+ "json": {
22
+ "name": "json",
23
+ "type": "boolean",
24
+ "description": "Format output as json.",
25
+ "helpGroup": "GLOBAL",
26
+ "allowNo": false
27
+ },
28
+ "file": {
29
+ "name": "file",
30
+ "type": "option",
31
+ "char": "f",
32
+ "summary": "The path of the Node.js script file to execute.",
33
+ "multiple": false
34
+ },
35
+ "target-org": {
36
+ "name": "target-org",
37
+ "type": "option",
38
+ "char": "o",
39
+ "multiple": false,
40
+ "aliases": [
41
+ "targetusername",
42
+ "u"
43
+ ]
44
+ },
45
+ "api-version": {
46
+ "name": "api-version",
47
+ "type": "option",
48
+ "description": "Override the api version used for api requests made by this command",
49
+ "multiple": false
50
+ }
51
+ },
52
+ "args": {},
53
+ "hasDynamicHelp": true
54
+ },
55
+ "kit:data:bulk:delete": {
56
+ "id": "kit:data:bulk:delete",
57
+ "summary": "Bulk delete records by SOQL select query.",
58
+ "strict": true,
59
+ "pluginName": "@kitalive/sfdx-plugin",
60
+ "pluginAlias": "@kitalive/sfdx-plugin",
61
+ "pluginType": "core",
62
+ "aliases": [],
63
+ "examples": [
64
+ "Delete Opportunity records with CloseDate older than 2 years:\n<%= config.bin %> <%= command.id %> -q \"SELECT Id FROM Opportunity WHERE CloseDate < LAST_N_YEARS:2\""
65
+ ],
66
+ "flags": {
67
+ "json": {
68
+ "name": "json",
69
+ "type": "boolean",
70
+ "description": "Format output as json.",
71
+ "helpGroup": "GLOBAL",
72
+ "allowNo": false
73
+ },
74
+ "query": {
75
+ "name": "query",
76
+ "type": "option",
77
+ "char": "q",
78
+ "summary": "SOQL query to delete",
79
+ "required": true,
80
+ "multiple": false
81
+ },
82
+ "hard": {
83
+ "name": "hard",
84
+ "type": "boolean",
85
+ "summary": "Perform a hard delete",
86
+ "allowNo": false
87
+ },
88
+ "concurrencymode": {
89
+ "name": "concurrencymode",
90
+ "type": "option",
91
+ "summary": "The concurrency mode (Parallel or Serial) for the job",
92
+ "multiple": false,
93
+ "default": "Parallel"
94
+ },
95
+ "batchsize": {
96
+ "name": "batchsize",
97
+ "type": "option",
98
+ "char": "s",
99
+ "summary": "The batch size of the job",
100
+ "multiple": false,
101
+ "default": 10000
102
+ },
103
+ "wait": {
104
+ "name": "wait",
105
+ "type": "option",
106
+ "char": "w",
107
+ "summary": "The number of minutes to wait for the command to complete before displaying the results",
108
+ "multiple": false
109
+ },
110
+ "target-org": {
111
+ "name": "target-org",
112
+ "type": "option",
113
+ "char": "o",
114
+ "summary": "Username or alias of the target org.",
115
+ "required": true,
116
+ "multiple": false,
117
+ "aliases": [
118
+ "targetusername",
119
+ "u"
120
+ ]
121
+ },
122
+ "api-version": {
123
+ "name": "api-version",
124
+ "type": "option",
125
+ "description": "Override the api version used for api requests made by this command",
126
+ "multiple": false
127
+ }
128
+ },
129
+ "args": {},
130
+ "hasDynamicHelp": true
131
+ },
132
+ "kit:data:bulk:insert": {
133
+ "id": "kit:data:bulk:insert",
134
+ "description": "For information about CSV file formats, see [Prepare CSV Files](https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/datafiles_csv_preparing.htm) in the Bulk API Developer Guide.",
135
+ "strict": true,
136
+ "pluginName": "@kitalive/sfdx-plugin",
137
+ "pluginAlias": "@kitalive/sfdx-plugin",
138
+ "pluginType": "core",
139
+ "aliases": [],
140
+ "examples": [
141
+ "Insert Account records with mapping.json:\n<%= config.bin %> <%= command.id %> -o Account -f ./path/to/Account.csv -m ./path/to/mapping.json",
142
+ "Insert MyObject\\_\\_c records with convert.js:\n<%= config.bin %> <%= command.id %> -o MyObject**c -f ./path/to/MyObject**c.csv -c ./path/to/convert.js -w 10"
143
+ ],
144
+ "flags": {
145
+ "json": {
146
+ "name": "json",
147
+ "type": "boolean",
148
+ "description": "Format output as json.",
149
+ "helpGroup": "GLOBAL",
150
+ "allowNo": false
151
+ },
152
+ "sobject": {
153
+ "name": "sobject",
154
+ "type": "option",
155
+ "char": "s",
156
+ "summary": "The SObject name to insert",
157
+ "required": true,
158
+ "multiple": false
159
+ },
160
+ "csvfile": {
161
+ "name": "csvfile",
162
+ "type": "option",
163
+ "char": "f",
164
+ "summary": "The CSV file path that defines the records to insert",
165
+ "required": true,
166
+ "multiple": false
167
+ },
168
+ "resultfile": {
169
+ "name": "resultfile",
170
+ "type": "option",
171
+ "char": "r",
172
+ "summary": "The CSV file path for writing the insert results",
173
+ "multiple": false
174
+ },
175
+ "encoding": {
176
+ "name": "encoding",
177
+ "type": "option",
178
+ "char": "e",
179
+ "summary": "The input CSV file encoding",
180
+ "multiple": false,
181
+ "default": "utf8"
182
+ },
183
+ "delimiter": {
184
+ "name": "delimiter",
185
+ "type": "option",
186
+ "char": "d",
187
+ "summary": "The input CSV file delimiter",
188
+ "multiple": false,
189
+ "default": ","
190
+ },
191
+ "quote": {
192
+ "name": "quote",
193
+ "type": "option",
194
+ "char": "q",
195
+ "summary": "The input CSV file quote character",
196
+ "multiple": false,
197
+ "default": "\""
198
+ },
199
+ "skiplines": {
200
+ "name": "skiplines",
201
+ "type": "option",
202
+ "summary": "The number of lines to skip",
203
+ "multiple": false,
204
+ "default": 0
205
+ },
206
+ "trim": {
207
+ "name": "trim",
208
+ "type": "boolean",
209
+ "summary": "Trim all white space from columns",
210
+ "allowNo": false
211
+ },
212
+ "mapping": {
213
+ "name": "mapping",
214
+ "type": "option",
215
+ "char": "m",
216
+ "summary": "The path of the JSON file that defines CSV column mappings",
217
+ "multiple": false
218
+ },
219
+ "converter": {
220
+ "name": "converter",
221
+ "type": "option",
222
+ "char": "c",
223
+ "summary": "The path of the script to convert CSV rows",
224
+ "multiple": false
225
+ },
226
+ "setnull": {
227
+ "name": "setnull",
228
+ "type": "boolean",
229
+ "summary": "Set blank values as null values during insert operations (default: empty field values are ignored)",
230
+ "allowNo": false
231
+ },
232
+ "convertonly": {
233
+ "name": "convertonly",
234
+ "type": "boolean",
235
+ "summary": "Output converted.csv file and skip insert for debugging",
236
+ "allowNo": false
237
+ },
238
+ "concurrencymode": {
239
+ "name": "concurrencymode",
240
+ "type": "option",
241
+ "summary": "The concurrency mode (Parallel or Serial) for the job",
242
+ "multiple": false,
243
+ "default": "Parallel"
244
+ },
245
+ "assignmentruleid": {
246
+ "name": "assignmentruleid",
247
+ "type": "option",
248
+ "summary": "The ID of a specific assignment rule to run for a case or a lead",
249
+ "multiple": false
250
+ },
251
+ "batchsize": {
252
+ "name": "batchsize",
253
+ "type": "option",
254
+ "summary": "The batch size of the job",
255
+ "multiple": false,
256
+ "default": 10000
257
+ },
258
+ "wait": {
259
+ "name": "wait",
260
+ "type": "option",
261
+ "char": "w",
262
+ "summary": "The number of minutes to wait for the command to complete before displaying the results",
263
+ "multiple": false
264
+ },
265
+ "target-org": {
266
+ "name": "target-org",
267
+ "type": "option",
268
+ "char": "o",
269
+ "summary": "Username or alias of the target org.",
270
+ "required": true,
271
+ "multiple": false,
272
+ "aliases": [
273
+ "targetusername",
274
+ "u"
275
+ ]
276
+ },
277
+ "api-version": {
278
+ "name": "api-version",
279
+ "type": "option",
280
+ "description": "Override the api version used for api requests made by this command",
281
+ "multiple": false
282
+ }
283
+ },
284
+ "args": {},
285
+ "requiresProject": false,
286
+ "hasDynamicHelp": true
287
+ },
288
+ "kit:data:bulk:query": {
289
+ "id": "kit:data:bulk:query",
290
+ "summary": "Bulk query records.",
291
+ "strict": true,
292
+ "pluginName": "@kitalive/sfdx-plugin",
293
+ "pluginAlias": "@kitalive/sfdx-plugin",
294
+ "pluginType": "core",
295
+ "aliases": [],
296
+ "examples": [
297
+ "Query Account records and save to specified path:\n<%= config.bin %> <%= command.id %> -q \"SELECT Id, Name FROM Account\" -f ./path/to/Account.csv"
298
+ ],
299
+ "flags": {
300
+ "json": {
301
+ "name": "json",
302
+ "type": "boolean",
303
+ "description": "Format output as json.",
304
+ "helpGroup": "GLOBAL",
305
+ "allowNo": false
306
+ },
307
+ "query": {
308
+ "name": "query",
309
+ "type": "option",
310
+ "char": "q",
311
+ "summary": "SOQL query to export",
312
+ "required": true,
313
+ "multiple": false
314
+ },
315
+ "csvfile": {
316
+ "name": "csvfile",
317
+ "type": "option",
318
+ "char": "f",
319
+ "summary": "[default: standard output] Output csv file",
320
+ "multiple": false
321
+ },
322
+ "target-org": {
323
+ "name": "target-org",
324
+ "type": "option",
325
+ "char": "o",
326
+ "summary": "Username or alias of the target org.",
327
+ "required": true,
328
+ "multiple": false,
329
+ "aliases": [
330
+ "targetusername",
331
+ "u"
332
+ ]
333
+ },
334
+ "api-version": {
335
+ "name": "api-version",
336
+ "type": "option",
337
+ "description": "Override the api version used for api requests made by this command",
338
+ "multiple": false
339
+ }
340
+ },
341
+ "args": {},
342
+ "hasDynamicHelp": true
343
+ },
344
+ "kit:data:bulk:update": {
345
+ "id": "kit:data:bulk:update",
346
+ "description": "For information about CSV file formats, see [Prepare CSV Files](https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/datafiles_csv_preparing.htm) in the Bulk API Developer Guide.",
347
+ "strict": true,
348
+ "pluginName": "@kitalive/sfdx-plugin",
349
+ "pluginAlias": "@kitalive/sfdx-plugin",
350
+ "pluginType": "core",
351
+ "aliases": [],
352
+ "examples": [
353
+ "Update Account records with mapping.json:\n<%= config.bin %> <%= command.id %> -o Account -f ./path/to/Account.csv -m ./path/to/mapping.json",
354
+ "Update MyObject\\_\\_c records with convert.js:\n<%= config.bin %> <%= command.id %> -o MyObject**c -f ./path/to/MyObject**c.csv -c ./path/to/convert.js -w 10"
355
+ ],
356
+ "flags": {
357
+ "json": {
358
+ "name": "json",
359
+ "type": "boolean",
360
+ "description": "Format output as json.",
361
+ "helpGroup": "GLOBAL",
362
+ "allowNo": false
363
+ },
364
+ "sobject": {
365
+ "name": "sobject",
366
+ "type": "option",
367
+ "char": "s",
368
+ "summary": "The SObject name to update",
369
+ "required": true,
370
+ "multiple": false
371
+ },
372
+ "csvfile": {
373
+ "name": "csvfile",
374
+ "type": "option",
375
+ "char": "f",
376
+ "summary": "The CSV file path that defines the records to update",
377
+ "required": true,
378
+ "multiple": false
379
+ },
380
+ "resultfile": {
381
+ "name": "resultfile",
382
+ "type": "option",
383
+ "char": "r",
384
+ "summary": "The CSV file path for writing the update results",
385
+ "multiple": false
386
+ },
387
+ "encoding": {
388
+ "name": "encoding",
389
+ "type": "option",
390
+ "char": "e",
391
+ "summary": "The input CSV file encoding",
392
+ "multiple": false,
393
+ "default": "utf8"
394
+ },
395
+ "delimiter": {
396
+ "name": "delimiter",
397
+ "type": "option",
398
+ "char": "d",
399
+ "summary": "The input CSV file delimiter",
400
+ "multiple": false,
401
+ "default": ","
402
+ },
403
+ "quote": {
404
+ "name": "quote",
405
+ "type": "option",
406
+ "char": "q",
407
+ "summary": "The input CSV file quote character",
408
+ "multiple": false,
409
+ "default": "\""
410
+ },
411
+ "skiplines": {
412
+ "name": "skiplines",
413
+ "type": "option",
414
+ "summary": "The number of lines to skip",
415
+ "multiple": false,
416
+ "default": 0
417
+ },
418
+ "trim": {
419
+ "name": "trim",
420
+ "type": "boolean",
421
+ "summary": "Trim all white space from columns",
422
+ "allowNo": false
423
+ },
424
+ "mapping": {
425
+ "name": "mapping",
426
+ "type": "option",
427
+ "char": "m",
428
+ "summary": "The path of the JSON file that defines CSV column mappings",
429
+ "multiple": false
430
+ },
431
+ "converter": {
432
+ "name": "converter",
433
+ "type": "option",
434
+ "char": "c",
435
+ "summary": "The path of the script to convert CSV rows",
436
+ "multiple": false
437
+ },
438
+ "setnull": {
439
+ "name": "setnull",
440
+ "type": "boolean",
441
+ "summary": "Set blank values as null values during update operations (default: empty field values are ignored)",
442
+ "allowNo": false
443
+ },
444
+ "convertonly": {
445
+ "name": "convertonly",
446
+ "type": "boolean",
447
+ "summary": "Output converted.csv file and skip update for debugging",
448
+ "allowNo": false
449
+ },
450
+ "concurrencymode": {
451
+ "name": "concurrencymode",
452
+ "type": "option",
453
+ "summary": "The concurrency mode (Parallel or Serial) for the job",
454
+ "multiple": false,
455
+ "default": "Parallel"
456
+ },
457
+ "assignmentruleid": {
458
+ "name": "assignmentruleid",
459
+ "type": "option",
460
+ "summary": "The ID of a specific assignment rule to run for a case or a lead",
461
+ "multiple": false
462
+ },
463
+ "batchsize": {
464
+ "name": "batchsize",
465
+ "type": "option",
466
+ "summary": "The batch size of the job",
467
+ "multiple": false,
468
+ "default": 10000
469
+ },
470
+ "wait": {
471
+ "name": "wait",
472
+ "type": "option",
473
+ "char": "w",
474
+ "summary": "The number of minutes to wait for the command to complete before displaying the results",
475
+ "multiple": false
476
+ },
477
+ "target-org": {
478
+ "name": "target-org",
479
+ "type": "option",
480
+ "char": "o",
481
+ "summary": "Username or alias of the target org.",
482
+ "required": true,
483
+ "multiple": false,
484
+ "aliases": [
485
+ "targetusername",
486
+ "u"
487
+ ]
488
+ },
489
+ "api-version": {
490
+ "name": "api-version",
491
+ "type": "option",
492
+ "description": "Override the api version used for api requests made by this command",
493
+ "multiple": false
494
+ }
495
+ },
496
+ "args": {},
497
+ "requiresProject": false,
498
+ "hasDynamicHelp": true
499
+ },
500
+ "kit:data:bulk:upsert": {
501
+ "id": "kit:data:bulk:upsert",
502
+ "description": "For information about CSV file formats, see [Prepare CSV Files](https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/datafiles_csv_preparing.htm) in the Bulk API Developer Guide.",
503
+ "strict": true,
504
+ "pluginName": "@kitalive/sfdx-plugin",
505
+ "pluginAlias": "@kitalive/sfdx-plugin",
506
+ "pluginType": "core",
507
+ "aliases": [],
508
+ "examples": [
509
+ "Upsert Account records with mapping.json:\n<%= config.bin %> <%= command.id %> -o Account -f ./path/to/Account.csv -m ./path/to/mapping.json",
510
+ "Upsert MyObject\\_\\_c with convert.js and external ID\n<%= config.bin %> <%= command.id %> -o MyObject**c -f ./path/to/MyObject**c.csv -c ./path/to/convert.js -i MyExternalId\\_\\_c -w 10"
511
+ ],
512
+ "flags": {
513
+ "json": {
514
+ "name": "json",
515
+ "type": "boolean",
516
+ "description": "Format output as json.",
517
+ "helpGroup": "GLOBAL",
518
+ "allowNo": false
519
+ },
520
+ "sobject": {
521
+ "name": "sobject",
522
+ "type": "option",
523
+ "char": "s",
524
+ "summary": "The SObject name to upsert",
525
+ "required": true,
526
+ "multiple": false
527
+ },
528
+ "csvfile": {
529
+ "name": "csvfile",
530
+ "type": "option",
531
+ "char": "f",
532
+ "summary": "The CSV file path that defines the records to upsert",
533
+ "required": true,
534
+ "multiple": false
535
+ },
536
+ "resultfile": {
537
+ "name": "resultfile",
538
+ "type": "option",
539
+ "char": "r",
540
+ "summary": "The CSV file path for writing the upsert results",
541
+ "multiple": false
542
+ },
543
+ "encoding": {
544
+ "name": "encoding",
545
+ "type": "option",
546
+ "char": "e",
547
+ "summary": "The input CSV file encoding",
548
+ "multiple": false,
549
+ "default": "utf8"
550
+ },
551
+ "delimiter": {
552
+ "name": "delimiter",
553
+ "type": "option",
554
+ "char": "d",
555
+ "summary": "The input CSV file delimiter",
556
+ "multiple": false,
557
+ "default": ","
558
+ },
559
+ "quote": {
560
+ "name": "quote",
561
+ "type": "option",
562
+ "char": "q",
563
+ "summary": "The input CSV file quote character",
564
+ "multiple": false,
565
+ "default": "\""
566
+ },
567
+ "skiplines": {
568
+ "name": "skiplines",
569
+ "type": "option",
570
+ "summary": "The number of lines to skip",
571
+ "multiple": false,
572
+ "default": 0
573
+ },
574
+ "trim": {
575
+ "name": "trim",
576
+ "type": "boolean",
577
+ "summary": "Trim all white space from columns",
578
+ "allowNo": false
579
+ },
580
+ "mapping": {
581
+ "name": "mapping",
582
+ "type": "option",
583
+ "char": "m",
584
+ "summary": "The path of the JSON file that defines CSV column mappings",
585
+ "multiple": false
586
+ },
587
+ "converter": {
588
+ "name": "converter",
589
+ "type": "option",
590
+ "char": "c",
591
+ "summary": "The path of the script to convert CSV rows",
592
+ "multiple": false
593
+ },
594
+ "setnull": {
595
+ "name": "setnull",
596
+ "type": "boolean",
597
+ "summary": "Set blank values as null values during upsert operations (default: empty field values are ignored)",
598
+ "allowNo": false
599
+ },
600
+ "convertonly": {
601
+ "name": "convertonly",
602
+ "type": "boolean",
603
+ "summary": "Output converted.csv file and skip upsert for debugging",
604
+ "allowNo": false
605
+ },
606
+ "concurrencymode": {
607
+ "name": "concurrencymode",
608
+ "type": "option",
609
+ "summary": "The concurrency mode (Parallel or Serial) for the job",
610
+ "multiple": false,
611
+ "default": "Parallel"
612
+ },
613
+ "assignmentruleid": {
614
+ "name": "assignmentruleid",
615
+ "type": "option",
616
+ "summary": "The ID of a specific assignment rule to run for a case or a lead",
617
+ "multiple": false
618
+ },
619
+ "batchsize": {
620
+ "name": "batchsize",
621
+ "type": "option",
622
+ "summary": "The batch size of the job",
623
+ "multiple": false,
624
+ "default": 10000
625
+ },
626
+ "wait": {
627
+ "name": "wait",
628
+ "type": "option",
629
+ "char": "w",
630
+ "summary": "The number of minutes to wait for the command to complete before displaying the results",
631
+ "multiple": false
632
+ },
633
+ "target-org": {
634
+ "name": "target-org",
635
+ "type": "option",
636
+ "char": "o",
637
+ "summary": "Username or alias of the target org.",
638
+ "required": true,
639
+ "multiple": false,
640
+ "aliases": [
641
+ "targetusername",
642
+ "u"
643
+ ]
644
+ },
645
+ "api-version": {
646
+ "name": "api-version",
647
+ "type": "option",
648
+ "description": "Override the api version used for api requests made by this command",
649
+ "multiple": false
650
+ },
651
+ "externalid": {
652
+ "name": "externalid",
653
+ "type": "option",
654
+ "char": "i",
655
+ "summary": "The column name of the external ID",
656
+ "required": true,
657
+ "multiple": false,
658
+ "default": "Id"
659
+ }
660
+ },
661
+ "args": {},
662
+ "requiresProject": false,
663
+ "hasDynamicHelp": true
664
+ },
665
+ "kit:data:csv:convert": {
666
+ "id": "kit:data:csv:convert",
667
+ "summary": "Convert CSV data using column mapping file or Node.js script.",
668
+ "strict": true,
669
+ "pluginName": "@kitalive/sfdx-plugin",
670
+ "pluginAlias": "@kitalive/sfdx-plugin",
671
+ "pluginType": "core",
672
+ "aliases": [],
673
+ "examples": [
674
+ "Convert csv file using mapping file and output to standard output:\n<%= config.bin %> <%= command.id %> -i ./path/to/input.csv -m ./path/to/mapping.json",
675
+ "Convert csv file using script and output to specified path:\n<%= config.bin %> <%= command.id %> -i ./path/to/input.csv -o ./path/to/output.csv -c ./path/to/convert.js"
676
+ ],
677
+ "flags": {
678
+ "json": {
679
+ "name": "json",
680
+ "type": "boolean",
681
+ "description": "Format output as json.",
682
+ "helpGroup": "GLOBAL",
683
+ "allowNo": false
684
+ },
685
+ "input": {
686
+ "name": "input",
687
+ "type": "option",
688
+ "char": "i",
689
+ "summary": "[default: standard input] The path of the input CSV file",
690
+ "multiple": false,
691
+ "aliases": [
692
+ "inputfile",
693
+ "f"
694
+ ]
695
+ },
696
+ "output": {
697
+ "name": "output",
698
+ "type": "option",
699
+ "char": "o",
700
+ "summary": "[default: standard output] The path of the output CSV file",
701
+ "multiple": false,
702
+ "aliases": [
703
+ "outputfile"
704
+ ]
705
+ },
706
+ "encoding": {
707
+ "name": "encoding",
708
+ "type": "option",
709
+ "char": "e",
710
+ "summary": "The input CSV file encoding",
711
+ "multiple": false,
712
+ "default": "utf8"
713
+ },
714
+ "delimiter": {
715
+ "name": "delimiter",
716
+ "type": "option",
717
+ "char": "d",
718
+ "summary": "The input CSV file delimiter",
719
+ "multiple": false,
720
+ "default": ","
721
+ },
722
+ "quote": {
723
+ "name": "quote",
724
+ "type": "option",
725
+ "char": "q",
726
+ "summary": "The input CSV file quote character",
727
+ "multiple": false,
728
+ "default": "\""
729
+ },
730
+ "skiplines": {
731
+ "name": "skiplines",
732
+ "type": "option",
733
+ "summary": "The number of lines to skip",
734
+ "multiple": false,
735
+ "default": 0
736
+ },
737
+ "trim": {
738
+ "name": "trim",
739
+ "type": "boolean",
740
+ "summary": "Trim all white space from columns",
741
+ "allowNo": false
742
+ },
743
+ "mapping": {
744
+ "name": "mapping",
745
+ "type": "option",
746
+ "char": "m",
747
+ "summary": "The path of the JSON file that defines CSV column mappings",
748
+ "multiple": false
749
+ },
750
+ "converter": {
751
+ "name": "converter",
752
+ "type": "option",
753
+ "char": "c",
754
+ "summary": "The path of the script to convert CSV rows",
755
+ "multiple": false
756
+ }
757
+ },
758
+ "args": {}
759
+ },
760
+ "kit:layout:assignments:deploy": {
761
+ "id": "kit:layout:assignments:deploy",
762
+ "summary": "Deploy page layout assignments from JSON file.",
763
+ "strict": true,
764
+ "pluginName": "@kitalive/sfdx-plugin",
765
+ "pluginAlias": "@kitalive/sfdx-plugin",
766
+ "pluginType": "core",
767
+ "aliases": [],
768
+ "examples": [
769
+ "Deploy from the default file path to the default org:\n<%= config.bin %> <%= command.id %>",
770
+ "Deploy from the specified file to the default org:\n<%= config.bin %> <%= command.id %> -f config/layout-assignments.scratch.json",
771
+ "Deploy from the specified file to the specified org:\n<%= config.bin %> <%= command.id %> -o me@my.org -f config/layout-assignments.sandbox.json"
772
+ ],
773
+ "flags": {
774
+ "json": {
775
+ "name": "json",
776
+ "type": "boolean",
777
+ "description": "Format output as json.",
778
+ "helpGroup": "GLOBAL",
779
+ "allowNo": false
780
+ },
781
+ "file": {
782
+ "name": "file",
783
+ "type": "option",
784
+ "char": "f",
785
+ "summary": "Input file path of page layout assignment settings.",
786
+ "required": true,
787
+ "multiple": false,
788
+ "default": "config/layout-assignments.json"
789
+ },
790
+ "target-org": {
791
+ "name": "target-org",
792
+ "type": "option",
793
+ "char": "o",
794
+ "summary": "Username or alias of the target org.",
795
+ "required": true,
796
+ "multiple": false,
797
+ "aliases": [
798
+ "targetusername",
799
+ "u"
800
+ ]
801
+ },
802
+ "api-version": {
803
+ "name": "api-version",
804
+ "type": "option",
805
+ "description": "Override the api version used for api requests made by this command",
806
+ "multiple": false
807
+ }
808
+ },
809
+ "args": {},
810
+ "requiresProject": true,
811
+ "hasDynamicHelp": true
812
+ },
813
+ "kit:layout:assignments:retrieve": {
814
+ "id": "kit:layout:assignments:retrieve",
815
+ "summary": "Retrieve page layout assignments and save to JSON file.",
816
+ "strict": true,
817
+ "pluginName": "@kitalive/sfdx-plugin",
818
+ "pluginAlias": "@kitalive/sfdx-plugin",
819
+ "pluginType": "core",
820
+ "aliases": [],
821
+ "examples": [
822
+ "Retrieve page layout assignments from the default org and save to the default path:\n<%= config.bin %> <%= command.id %>",
823
+ "Retrieve Admin profile's Account and Contact page layout assignments and save to the specified path:\n<%= config.bin %> <%= command.id %> -p Admin -s Account -s Contact -f config/layout-assignments.scratch.json",
824
+ "Retrieve page layout assignments from the specified org and save to the specified path:\n<%= config.bin %> <%= command.id %> -o me@my.org -f config/layout-assignments.sandbox.json"
825
+ ],
826
+ "flags": {
827
+ "json": {
828
+ "name": "json",
829
+ "type": "boolean",
830
+ "description": "Format output as json.",
831
+ "helpGroup": "GLOBAL",
832
+ "allowNo": false
833
+ },
834
+ "file": {
835
+ "name": "file",
836
+ "type": "option",
837
+ "char": "f",
838
+ "summary": "Output file path of page layout assignment settings.",
839
+ "required": true,
840
+ "multiple": false,
841
+ "default": "config/layout-assignments.json"
842
+ },
843
+ "profile": {
844
+ "name": "profile",
845
+ "type": "option",
846
+ "char": "p",
847
+ "summary": "[default: all profiles] Profile names to retrieve",
848
+ "required": false,
849
+ "multiple": true
850
+ },
851
+ "sobject": {
852
+ "name": "sobject",
853
+ "type": "option",
854
+ "char": "s",
855
+ "summary": "[default: sobjects which have multiple layouts] SObject names to retrieve",
856
+ "required": false,
857
+ "multiple": true
858
+ },
859
+ "merge": {
860
+ "name": "merge",
861
+ "type": "boolean",
862
+ "summary": "Merge retrieved configurations with existing file.",
863
+ "required": false,
864
+ "allowNo": false
865
+ },
866
+ "target-org": {
867
+ "name": "target-org",
868
+ "type": "option",
869
+ "char": "o",
870
+ "summary": "Username or alias of the target org.",
871
+ "required": true,
872
+ "multiple": false,
873
+ "aliases": [
874
+ "targetusername",
875
+ "u"
876
+ ]
877
+ },
878
+ "api-version": {
879
+ "name": "api-version",
880
+ "type": "option",
881
+ "description": "Override the api version used for api requests made by this command",
882
+ "multiple": false
883
+ }
884
+ },
885
+ "args": {},
886
+ "requiresProject": true,
887
+ "hasDynamicHelp": true
888
+ },
889
+ "kit:object:fields:describe": {
890
+ "id": "kit:object:fields:describe",
891
+ "summary": "Describe sobject fields information.",
892
+ "strict": true,
893
+ "pluginName": "@kitalive/sfdx-plugin",
894
+ "pluginAlias": "@kitalive/sfdx-plugin",
895
+ "pluginType": "core",
896
+ "aliases": [],
897
+ "examples": [
898
+ "Describe Account fields of the default org and save to csv file:\n<%= config.bin %> <%= command.id %> -s Account -f path/to/account_fields.csv",
899
+ "Output CustomObject\\_\\_c fields of the specified org as JSON format:\n<%= config.bin %> <%= command.id %> -o me@my.org -s CustomObject\\_\\_c --json"
900
+ ],
901
+ "flags": {
902
+ "json": {
903
+ "name": "json",
904
+ "type": "boolean",
905
+ "description": "Format output as json.",
906
+ "helpGroup": "GLOBAL",
907
+ "allowNo": false
908
+ },
909
+ "sobject": {
910
+ "name": "sobject",
911
+ "type": "option",
912
+ "char": "s",
913
+ "summary": "SObject name to describe",
914
+ "required": true,
915
+ "multiple": false
916
+ },
917
+ "file": {
918
+ "name": "file",
919
+ "type": "option",
920
+ "char": "f",
921
+ "summary": "Output csv file path",
922
+ "multiple": false
923
+ },
924
+ "target-org": {
925
+ "name": "target-org",
926
+ "type": "option",
927
+ "char": "o",
928
+ "summary": "Username or alias of the target org.",
929
+ "required": true,
930
+ "multiple": false,
931
+ "aliases": [
932
+ "targetusername",
933
+ "u"
934
+ ]
935
+ },
936
+ "api-version": {
937
+ "name": "api-version",
938
+ "type": "option",
939
+ "description": "Override the api version used for api requests made by this command",
940
+ "multiple": false
941
+ }
942
+ },
943
+ "args": {},
944
+ "hasDynamicHelp": true
945
+ },
946
+ "kit:object:fields:setup": {
947
+ "id": "kit:object:fields:setup",
948
+ "summary": "Upsert and delete sobject fields from a CSV file.",
949
+ "strict": true,
950
+ "pluginName": "@kitalive/sfdx-plugin",
951
+ "pluginAlias": "@kitalive/sfdx-plugin",
952
+ "pluginType": "core",
953
+ "aliases": [],
954
+ "examples": [
955
+ "Upsert Account fields to the default org:\n<%= config.bin %> <%= command.id %> -s Account -f path/to/account_fields.csv",
956
+ "Upsert and delete CustomObject\\_\\_c fields to the specified org:\n<%= config.bin %> <%= command.id %> -o me@my.org -s CustomObject\\_\\_c -f path/to/custom_object_fields.csv --delete"
957
+ ],
958
+ "flags": {
959
+ "json": {
960
+ "name": "json",
961
+ "type": "boolean",
962
+ "description": "Format output as json.",
963
+ "helpGroup": "GLOBAL",
964
+ "allowNo": false
965
+ },
966
+ "sobject": {
967
+ "name": "sobject",
968
+ "type": "option",
969
+ "char": "s",
970
+ "summary": "SObject name to setup",
971
+ "required": true,
972
+ "multiple": false
973
+ },
974
+ "file": {
975
+ "name": "file",
976
+ "type": "option",
977
+ "char": "f",
978
+ "summary": "Input csv file path",
979
+ "required": true,
980
+ "multiple": false
981
+ },
982
+ "delete": {
983
+ "name": "delete",
984
+ "type": "boolean",
985
+ "summary": "Delete fields that are not in the csv file",
986
+ "allowNo": false
987
+ },
988
+ "force": {
989
+ "name": "force",
990
+ "type": "boolean",
991
+ "summary": "Do not confirm when deleting",
992
+ "allowNo": false
993
+ },
994
+ "target-org": {
995
+ "name": "target-org",
996
+ "type": "option",
997
+ "char": "o",
998
+ "summary": "Username or alias of the target org.",
999
+ "required": true,
1000
+ "multiple": false,
1001
+ "aliases": [
1002
+ "targetusername",
1003
+ "u"
1004
+ ]
1005
+ },
1006
+ "api-version": {
1007
+ "name": "api-version",
1008
+ "type": "option",
1009
+ "description": "Override the api version used for api requests made by this command",
1010
+ "multiple": false
1011
+ }
1012
+ },
1013
+ "args": {},
1014
+ "hasDynamicHelp": true
1015
+ }
1016
+ }
1017
+ }