@kitalive/sfdx-plugin 0.4.5 → 0.5.0

package/messages/data.bulk.md

@@ -0,0 +1,54 @@
+# examples
+
+- %s Account records with mapping.json:
+
+  <%= config.bin %> <%= command.id %> -o Account -f ./path/to/Account.csv -m ./path/to/mapping.json
+
+- %s MyObject\_\_c records with convert.js:
+
+  <%= config.bin %> <%= command.id %> -o MyObject**c -f ./path/to/MyObject**c.csv -c ./path/to/convert.js -w 10
+
+# 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.
+
+# flags.sobject.summary
+
+The SObject name to %s
+
+# flags.csvfile.summary
+
+The CSV file path that defines the records to %s
+
+# flags.resultfile.summary
+
+The CSV file path for writing the %s results
+
+# flags.setnull.summary
+
+Set blank values as null values during %s operations (default: empty field values are ignored)
+
+# flags.convertonly.summary
+
+Output converted.csv file and skip %s for debugging
+
+# flags.concurrencymode.summary
+
+The concurrency mode (Parallel or Serial) for the job
+
+# flags.batchsize.summary
+
+The batch size of the job
+
+# flags.wait.summary
+
+The number of minutes to wait for the command to complete before displaying the results
+
+# flags.assignmentruleid.summary
+
+The ID of a specific assignment rule to run for a case or a lead
+
+# asyncJob
+
+Check bulk job status with the command:
+%s org open -o %s -p "lightning/setup/AsyncApiJobStatus/page?address=%2F%s"

package/messages/data.bulk.query.md

@@ -0,0 +1,17 @@
+# summary
+
+Bulk query records.
+
+# examples
+
+- Query Account records and save to specified path:
+
+  <%= config.bin %> <%= command.id %> -q "SELECT Id, Name FROM Account" -f ./path/to/Account.csv
+
+# flags.query.summary
+
+SOQL query to export
+
+# flags.csvfile.summary
+
+[default: standard output] Output csv file

package/messages/data.bulk.upsert.md

@@ -0,0 +1,13 @@
+# examples
+
+- Upsert Account records with mapping.json:
+
+  <%= config.bin %> <%= command.id %> -o Account -f ./path/to/Account.csv -m ./path/to/mapping.json
+
+- Upsert MyObject\_\_c with convert.js and external ID
+
+  <%= config.bin %> <%= command.id %> -o MyObject**c -f ./path/to/MyObject**c.csv -c ./path/to/convert.js -i MyExternalId\_\_c -w 10
+
+# flags.externalid.summary
+
+The column name of the external ID

package/messages/data.csv.convert.md

@@ -0,0 +1,49 @@
+# summary
+
+Convert CSV data using column mapping file or Node.js script.
+
+# examples
+
+- Convert csv file using mapping file and output to standard output:
+
+  <%= config.bin %> <%= command.id %> -i ./path/to/input.csv -m ./path/to/mapping.json
+
+- Convert csv file using script and output to specified path:
+
+  <%= config.bin %> <%= command.id %> -i ./path/to/input.csv -o ./path/to/output.csv -c ./path/to/convert.js
+
+# flags.input.summary
+
+[default: standard input] The path of the input CSV file
+
+# flags.output.summary
+
+[default: standard output] The path of the output CSV file
+
+# flags.encoding.summary
+
+The input CSV file encoding
+
+# flags.delimiter.summary
+
+The input CSV file delimiter
+
+# flags.quote.summary
+
+The input CSV file quote character
+
+# flags.skiplines.summary
+
+The number of lines to skip
+
+# flags.trim.summary
+
+Trim all white space from columns
+
+# flags.mapping.summary
+
+The path of the JSON file that defines CSV column mappings
+
+# flags.converter.summary
+
+The path of the script to convert CSV rows

package/messages/layout.assignments.deploy.md

@@ -0,0 +1,24 @@
+# summary
+
+Deploy page layout assignments from JSON file.
+
+# examples
+
+- Deploy from the default file path to the default org:
+
+  <%= config.bin %> <%= command.id %>
+
+- Deploy from the specified file to the default org:
+
+  <%= config.bin %> <%= command.id %> -f config/layout-assignments.scratch.json
+
+- Deploy from the specified file to the specified org:
+  <%= config.bin %> <%= command.id %> -o me@my.org -f config/layout-assignments.sandbox.json
+
+# flags.file.summary
+
+Input file path of page layout assignment settings.
+
+# spinner.start
+
+Deploy page layout assignments from %s

package/messages/layout.assignments.retrieve.md

@@ -0,0 +1,46 @@
+# summary
+
+Retrieve page layout assignments and save to JSON file.
+
+# examples
+
+- Retrieve page layout assignments from the default org and save to the default path:
+
+  <%= config.bin %> <%= command.id %>
+
+- Retrieve Admin profile's Account and Contact page layout assignments and save to the specified path:
+
+  <%= config.bin %> <%= command.id %> -p Admin -s Account -s Contact -f config/layout-assignments.scratch.json
+
+- Retrieve page layout assignments from the specified org and save to the specified path:
+  <%= config.bin %> <%= command.id %> -o me@my.org -f config/layout-assignments.sandbox.json
+
+# flags.file.summary
+
+Output file path of page layout assignment settings.
+
+# flags.profile.summary
+
+[default: all profiles] Profile names to retrieve
+
+# flags.sobject.summary
+
+[default: sobjects which have multiple layouts] SObject names to retrieve
+
+# flags.merge.summary
+
+Merge retrieved configurations with existing file.
+
+# spinner.start
+
+Retrieve page layout assignments
+
+# result
+
+Saved to %s:
+profiles: %s
+sobjects: %s
+
+# error.noSObjects
+
+There are no sobjects to retrieve.

package/messages/object.fields.describe.md

@@ -0,0 +1,25 @@
+# summary
+
+Describe sobject fields information.
+
+# examples
+
+- Describe Account fields of the default org and save to csv file:
+
+  <%= config.bin %> <%= command.id %> -s Account -f path/to/account_fields.csv
+
+- Output CustomObject\_\_c fields of the specified org as JSON format:
+
+  <%= config.bin %> <%= command.id %> -o me@my.org -s CustomObject\_\_c --json
+
+# flags.sobject.summary
+
+SObject name to describe
+
+# flags.file.summary
+
+Output csv file path
+
+# spinner.start
+
+Describe %s fields

package/messages/object.fields.setup.md

@@ -0,0 +1,29 @@
+# summary
+
+Upsert and delete sobject fields from a CSV file.
+
+# examples
+
+- Upsert Account fields to the default org:
+
+  <%= config.bin %> <%= command.id %> -s Account -f path/to/account_fields.csv
+
+- Upsert and delete CustomObject\_\_c fields to the specified org:
+
+  <%= config.bin %> <%= command.id %> -o me@my.org -s CustomObject\_\_c -f path/to/custom_object_fields.csv --delete
+
+# flags.sobject.summary
+
+SObject name to setup
+
+# flags.file.summary
+
+Input csv file path
+
+# flags.delete.summary
+
+Delete fields that are not in the csv file
+
+# flags.force.summary
+
+Do not confirm when deleting

package/messages/script.execute.md

@@ -0,0 +1,42 @@
+# summary
+
+Execute Node.js scripts in SfCommand context.
+
+# description
+
+Available variables in Node.js scripts
+
+- argv: Parsed command line arguments after the file option
+- conn: jsforce Connection
+- context: SfCommand
+
+# examples
+
+- Execute from js file:
+
+  <%= config.bin %> <%= command.id %> -f ./path/to/script.js
+
+- Execute in REPL mode:
+
+  <%= config.bin %> <%= command.id %> -o target-org
+
+- query a account from org in REPL
+
+  > 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 <%= config.bin %> <%= command.id %>
+
+# flags.file.summary
+
+The path of the Node.js script file to execute.
+
+# repl.start
+
+Starting REPL mode
+Available variables
+
+- conn: jsforce Connection
+- context: SfCommand
+
+Type .exit or Press Ctrl+D to exit the REPL