@pdfbutler/migration-cli 0.0.14 → 0.0.16

package/README.md

@@ -69,6 +69,15 @@ $ sf butler pb export [options]
 $ sf butler pb import [options]
 ```
 
+## Recommended CLI Shell:
+```
+Windows - PowerShell
+MacOS - zsh
+Linux - bash
+
+One of the common errors in Windows Command Prompt is incorrectly parsing command parameters within quotes.
+```
+
 ## Commands
 
 ## butler pb export
@@ -81,7 +90,8 @@ $ sf butler pb export [--target | -t <value>] [--id | -i <value>] [--out | -o <v
 
 FLAGS
     -t, --target=<value>         The Salesforce org username credentials to connect to the target org. (Required)
-    -i, --id=<value>             The ID of the PDF Butler docuemnt configuration to export. (Required)
+    -i, --id=<value>             The ID of the PDF Butler docuemnt configuration to export. 
+                                 For bulk export, enter multiple docuemnt configuration IDs separated by whitespaces.  (Required)
     -o, --out=<value>            The value specifies the path to the folder with the exported configuration and archive name. (Required)
     -s, --stage=<value>          The CADMUS stage. (Required)
     -a, --auth-env-var=<value>   The PDF Butler credentials for backend authentication. (Required)
@@ -263,7 +273,7 @@ EXAMPLES
                 }
             }
 
-    Run with --partial flag only
+    Run with --partial flag only (bulk export)
 
         $ sf butler pb export -t sfusername@sandbox.com -i 'document_configuration_id_1, invalid_document_configuration_id_2'
             -o 'export_folder_name/archive_or_folder_name' -s 'TEST' -e 'https://eu1.pdfbutler.com'
@@ -285,7 +295,7 @@ EXAMPLES
                 }
             }
 
-    Run without --partial flag
+    Run without --partial flag (bulk export)
 
         $ sf butler pb export -t sfusername@sandbox.com -i 'document_configuration_id_1, invalid_document_configuration_id_2'
             -o 'export_folder_name/archive_or_folder_name' -s 'TEST' -e 'https://eu1.pdfbutler.com'
@@ -293,6 +303,32 @@ EXAMPLES
 
         # Console output:
             Error (1): One or more docConfigs have no backend.
+            
+    Run without --partial flag (bulk export)
+
+        $ sf butler pb export -t sfusername@sandbox.com -i 'document_configuration_id_1, document_configuration_id_2'
+            -o 'export_folder_name/archive_or_folder_name' -s 'TEST' -e 'https://eu1.pdfbutler.com'
+            -a 'pdf_butler_user_name-ADMIN:admin_password'
+
+        # Created:
+            Directory 'export_folder_name/archive_or_folder_name'{
+                Directory 'sfdc'{
+                    file 'docconfig_id_1.json',
+                    file 'docconfig_id_2.json',
+                },
+                zip file'docconfig_id_1.zip'{
+                    Directory 'ConfigTypes',
+                    Directory 'DataSources',
+                    file 'doc-config.json',
+                    file 'TemplateName.docx'
+                },
+                zip file'docconfig_id_2.zip'{
+                    Directory 'ConfigTypes',
+                    Directory 'DataSources',
+                    file 'doc-config.json',
+                    file 'TemplateName.docx'
+                }
+            }
 
     Run with --backend flag and other optional flags
 
@@ -363,7 +399,7 @@ FLAG DESCRIPTIONS
         This flag is required to authenticate and access the PDF Butler configurations.
 
     -i, --id <value>
-        Specifies the unique ID of the PDF Butler document configuration to be exported.
+        Specifies the unique ID of the PDF Butler document configuration to be exported. For bulk export, enter multiple docuemnt configuration IDs separated by whitespaces.
         This ID uniquely identifies the configuration you want to export. It is a required parameter.
 
     -o, --out <value>
@@ -409,7 +445,8 @@ $ sf butler pb import [--target | -t <value>] [--id | -i <value>] [--auth-env-va
 
 FLAGS
     -t, --target=<value>          The Salesforce org username credentials to connect to the target org. (Required)
-    -i, --id=<value>              The ID of the PDF Butler docuemnt configurations to import. (Required)
+    -i, --id=<value>              The ID of the PDF Butler docuemnt configurations to import. 
+                                  For bulk import, enter multiple docuemnt configuration IDs separated by whitespaces.(Required)
     -a, --auth-env-var=<value>    The PDF Butler credentials for backend authentication. (Required)
     -e, --endpoint=<value>        The URL PDF Butler endpoint for import. (Required)
                                   Please use the following region-specific URLs on the region in which you registered:
@@ -436,6 +473,14 @@ EXAMPLE
 
     $ sf butler pb import -t sfusername@sandbox.com -i 'document_configuration_id' -f .export_folder_name/archive_or_folder_name
         -e 'https://eu1.pdfbutler.com' -a 'pdf_butler_user_name-ADMIN:admin_password' -s 'UAT'
+        
+        Import configurations to the organization:
+
+
+    Bulk import configurations to the organization:
+    
+    $ sf butler pb import -t sfusername@sandbox.com -i 'document_configuration_id document_configuration_id2' -f .export_folder_name/archive_or_folder_name
+        -e 'https://eu1.pdfbutler.com' -a 'pdf_butler_user_name-ADMIN:admin_password' -s 'UAT'
 
 FLAG DESCRIPTIONS
     -t, --target <value>
@@ -443,8 +488,8 @@ FLAG DESCRIPTIONS
         org where the PDF Butler configurations will be imported. This flag is required for authentication.
         
     -i, --id <value>
-        Specifies the unique ID of the PDF Butler document configuration to be exported.
-        This ID uniquely identifies the configuration you want to export. It is a required parameter.
+        Specifies the unique ID of the PDF Butler document configuration to be imported.
+        This ID uniquely identifies the configuration you want to import. It is a required parameter.
 
     -a, --auth-env-var <value>
         Specifies the PDF Butler credentials for backend authentication. For authenification should be used PDF butler username and admin password.
@@ -455,8 +500,8 @@ FLAG DESCRIPTIONS
         Specifies a URL endpoint for import. Use this flag if you need to specify a custom import endpoint.
 
     -s, --stage <value>
-                Specifies the stage or environment for the export process.
-        This flag helps in categorizing or labeling the exported data according to different stages. For example: TEST, UAT, PROD.
+        Specifies the stage or environment for the import process.
+        This flag helps in categorizing or labeling the imported data according to different stages. For example: TEST, UAT, PROD.
         It is a required parameter.
 
     -f, --config <value>
@@ -508,6 +553,7 @@ SOLUTION: When using the --id flag, make sure to provide a valid value after the
 ```
 SOLUTION: Verify that the Doc Config IDs you provided are correct and exist in the system.
 
+
 ```
 
 - Error (1): One or more docConfigs have no backend.

package/oclif.manifest.json

@@ -1,5 +1,5 @@
 {
-  "version": "0.0.14",
+  "version": "0.0.16",
   "commands": {
     "butler:pb:export": {
       "id": "butler:pb:export",

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@pdfbutler/migration-cli",
   "description": "[![NPM](https://img.shields.io/npm/v/pdfbutler-migration-cli.svg?label=pdfbutler-migration-cli)](https://www.npmjs.com/package/pdfbutler-migration-cli) [![Downloads/week](https://img.shields.io/npm/dw/pdfbutler-migration-cli.svg)](https://npmjs.org/package/pdfbutler-migration-cli) [![License](https://img.shields.io/badge/License-BSD%203--Clause-brightgreen.svg)](https://raw.githubusercontent.com/salesforcecli/pdfbutler-migration-cli/main/LICENSE.txt)",
-  "version": "0.0.14",
+  "version": "0.0.16",
   "script": {
     "postinstall": "sf plugins link @pdfbutler/migration-cli"
   },