@pdfbutler/migration-cli 0.0.18 → 0.0.20

package/README.md

@@ -7,8 +7,8 @@
 v0.0.11 updates: <br/>
 
 - '-b' flag disables backend export. If specified, the export operation doesn't use a PDF Butler backend process for exporting the configuration. By default, backend export is enabled.
-- New '-l --logs' flag. Use this flag to enable a more detailed log of the migration process.
-- New '-p --partial' flag. Use this flag to ignore invalid document configurations and allow the export of document configuration files with the backend part.
+- '-l --logs' flag. Use this flag to enable a more detailed log of the migration process.
+- '-p --partial' flag. Use this flag to ignore invalid document configurations and allow the export of document configuration files with the backend part.
 
 v0.0.14 updates: <br/>
 
@@ -18,6 +18,20 @@ v0.0.17 updates: <br/>
 
 - The '-c' or '--clone' flag has been added to the import command. Use '-c' or '--clone' to allow inserting new DocConfigs instead of updating existing ones.
 
+v.0.0.18 updates: <br/>
+This release introduces several new commands to enhance the management and deployment of PDFButler Packs and administrative settings in your org. Here’s a breakdown of the new commands and their functionality:
+
+- 'exportpack'. Allows you to export a PDFButler Pack from the org to an external file.
+- 'importpack'. Facilitates importing a previously exported PDFButler Pack into your org.
+- 'adminsettings'. Allows you to configure critical PDFButler settings such as the service URL, region, and stage.
+- 'admincredentials'. Enables you to securely provide or update the PDFButler admin credentials.
+
+v.0.0.20 updates <br/>
+This release introduces an alternative authentication method to enhance flexibility when connecting to Salesforce. The new functionality includes support for session-based authentication, allowing users to connect without relying solely on username.
+Additionally, two new optional flags, --session and --instance, have been added to all commands to support this authentication method:
+
+- '--session'. Allows you to provide a Salesforce Session Id for authentication.
+- '--instance'. Specifies the Salesforce Instance URL for authentication.
 ## About
 
 @pdfbutler/migration-cli is a Salesforce plugin designed to simplify and automate the process of migrating configurations within the PDF Butler system in the Salesforce environment. PDF Butler is a powerful tool for generating and automating documents in the Salesforce platform, and the use of this CLI plugin allows users to easily manage configurations and transfer them between different Salesforce instances or projects.
@@ -67,11 +81,24 @@ One of the options to authorize an org is by running a CLI command and entering
 sf org login web
 ```
 
+Alternatively, you can provide the --session and --instance flags directly during command execution to authenticate using a Salesforce Session ID and Instance URL. This method allows you to bypass the browser-based login and authenticate seamlessly:
+
+```
+command ... --session "SessionId" --instance "https://yourInstance.sale
+```
+
+Pay attention! <br/>
+If you provide only the --target flag, authentication will occur using the specified target org credentials. However, if you also include the --session and --instance flags, these values will take precedence, and the authentication process will rely on the session-based method. This allows for a flexible authentication approach tailored to your needs.
+
 After the installation and authorization are complete, you can call this plugin by using its name in the terminal or command prompt to export and import PDF Butler configurations in Salesforce. For example:
 
 ```
 $ sf butler pb export [options]
 $ sf butler pb import [options]
+$ sf butler pb exportpack [options]
+$ sf butler pb importpack [options]
+$ sf butler pb adminsettings [options]
+$ sf butler pb admincredentials [options]
 ```
 
 ## Recommended CLI Shell:
@@ -92,12 +119,12 @@ Export PDF Butler configurations.
 
 ```
 USAGE
-$ sf butler pb export [--target | -t <value>] [--id | -i <value>] [--out | -o <value>] [--stage | -s <value>] [--auth-env-var | -a <value>] [--endpoint | -e <value>] [--backend | -b] [--unzip | -u] [-l | --logs] [-p | --partial]
+$ sf butler pb export [--target | -t <value>] [--id | -i <value>] [--out | -o <value>] [--stage | -s <value>] [--auth-env-var | -a <value>] [--endpoint | -e <value>] [--backend | -b] [--unzip | -u] [-l | --logs] [-p | --partial] [--session <value>] [--instance <value>]
 
 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 document configuration to export.
-                                 For bulk export, enter multiple docuemnt configuration IDs separated by whitespaces.  (Required)
+                                 For bulk export, enter multiple docuemnt configuration IDs separated by Customer Pack Id.  (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)
@@ -112,6 +139,8 @@ FLAGS
     -b, --backend                Use this flag to disable PDF Butler backend export. (Optional)
     -l, --logs                   Use it to get a more detailed log of migration process. (Optional)
     -p, --partial                Use this flag to ignore invalid document configurations and allow the export of document configuration files with the backend part. (Optional)
+    --session=<value>            This flag is used to provide a Salesforce Session ID for authentication.
+    --instance=<value>           This flag specifies the Salesforce Instance URL. The Instance URL corresponds to the specific Salesforce environment (e.g., production, sandbox) you are connecting to.
 
 DESCRIPTION
     Export DocConfigs and related DataSource files from your organization.
@@ -128,7 +157,7 @@ DESCRIPTION
     get a more detailed log of migration process and even choose to unzip the exported configuration.
 
 EXAMPLES
-    Run with --backend flag only
+    Run with --backend flag
 
         $ sf butler pb export -t sfusername@sandbox.com -i 'document_configuration_id'
             -o 'export_folder_name/archive_or_folder_name' -s 'TEST' -e 'https://eu1.pdfbutler.com'
@@ -164,7 +193,7 @@ EXAMPLES
                 }
             }
 
-    Run with --unzip flag only
+    Run with --unzip flag
 
         $ sf butler pb export -t sfusername@sandbox.com -i 'document_configuration_id'
             -o 'export_folder_name/archive_or_folder_name' -s 'TEST' -e 'https://eu1.pdfbutler.com'
@@ -208,7 +237,7 @@ EXAMPLES
                 }
             }
 
-    Run with --logs flag only
+    Run with --logs flag
 
         $ sf butler pb export -t sfusername@sandbox.com -i 'document_configuration_id'
             -o 'export_folder_name/archive_or_folder_name' -s 'TEST' -e 'https://eu1.pdfbutler.com'
@@ -257,29 +286,7 @@ EXAMPLES
                 }
             }
 
-    Run with --partial flag only and docconfig with backend part
-
-        $ sf butler pb export -t sfusername@sandbox.com -i 'document_configuration_id'
-            -o 'export_folder_name/archive_or_folder_name' -s 'TEST' -e 'https://eu1.pdfbutler.com'
-            -a 'pdf_butler_user_name-ADMIN:admin_password' -p
-
-        # Console output:
-            Connected to sfusername@sandbox.com (00D06000001aXGkEAM) with API version 58.0
-
-        # Created:
-            Directory 'export_folder_name/archive_or_folder_name'{
-                Directory 'sfdc'{
-                    file 'docconfig_id.json',
-                },
-                zip file'docconfig_id.zip'{
-                    Directory 'ConfigTypes',
-                    Directory 'DataSources',
-                    file 'doc-config.json',
-                    file 'TemplateName.docx'
-                }
-            }
-
-    Run with --partial flag only (bulk export)
+    Run with --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'
@@ -310,94 +317,6 @@ 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
-
-        $ sf butler pb export -t sfusername@sandbox.com -i 'document_configuration_id'
-            -o 'export_folder_name/archive_or_folder_name' -s 'TEST' -e 'https://eu1.pdfbutler.com'
-            -a 'pdf_butler_user_name-ADMIN:admin_password' -b [-u | -l | -p]
-
-        # Console output:
-            Connected to sfusername@sandbox.com (00D06000001aXGkEAM) with API version 58.0
-
-        # Created:
-            Directory 'export_folder_name/archive_or_folder_name/sfdc'{
-                file 'docconfig_id_1.json'
-            }
-
-    Run with --unzip and --logs flags
-
-        $ sf butler pb export -t sfusername@sandbox.com -i 'document_configuration_id'
-            -o 'export_folder_name/archive_or_folder_name' -s 'TEST' -e 'https://eu1.pdfbutler.com'
-            -a 'pdf_butler_user_name-ADMIN:admin_password' -u -l
-
-        # Console output:
-            Connected to sfusername@sandbox.com (00D06000001aXGkEAM) with API version 58.0
-            DocConfig exported - 10061
-            Exported data from backend - 71940
-            Exported data from backend has been archived
-            User has read/write permissions
-            Archive unzipped and recorded locally
-
-        # Created:
-            Directory 'export_folder_name/archive_or_folder_name'{
-                Directory 'sfdc'{
-                    file 'document_configuration_id.json',
-                },
-                Unziped directory 'document_configuration_id'{
-                    Directory 'ConfigTypes',
-                    Directory 'DataSources',
-                    file 'doc-config.json',
-                    file 'TemplateName.docx'
-                }
-            }
-
-    Run without optional flags
-
-        $ sf butler pb export -t sfusername@sandbox.com -i 'document_configuration_id'
-            -o 'export_folder_name/archive_or_folder_name' -s 'TEST' -e 'https://eu1.pdfbutler.com'
-            -a 'pdf_butler_user_name-ADMIN:admin_password'
-
-        # Console output:
-            Connected to sfusername@sandbox.com (00D06000001aXGkEAM) with API version 58.0
-
-        # Created:
-            Directory 'export_folder_name/archive_or_folder_name'{
-                Directory 'sfdc'{
-                    file 'document_configuration_id.json',
-                },
-                zip file'document_configuration_id.zip'{
-                    Directory 'ConfigTypes',
-                    Directory 'DataSources',
-                    file 'doc-config.json',
-                    file 'TemplateName.docx'
-                }
-            }
 
 FLAG DESCRIPTIONS
     -t, --target <value>
@@ -439,6 +358,12 @@ FLAG DESCRIPTIONS
 
     -p, --partial
         Use this flag to ignore invalid document configurations and allow the export of document configuration files with the backend part.
+
+    --session
+        This flag is used to provide a Salesforce Session ID for authentication.
+    
+    --instance
+        This flag specifies the Salesforce Instance URL. The Instance URL corresponds to the specific Salesforce environment (e.g., production, sandbox) you are connecting to.
 ```
 
 ## butler pb import
@@ -447,7 +372,7 @@ Import PDF Butler document configurations and related DataSource files.
 
 ```
 USAGE
-$ sf butler pb import [--target | -t <value>] [--id | -i <value>] [--auth-env-var | -a <value>] [--endpoint | -e <value>] [--stage | -s <value>] [--config | -f <value>] [-c | --clone]
+$ sf butler pb import [--target | -t <value>] [--id | -i <value>] [--auth-env-var | -a <value>] [--endpoint | -e <value>] [--stage | -s <value>] [--config | -f <value>] [-c | --clone] [--session <value>] [--instance <value>]
 
 FLAGS
     -t, --target=<value>          The Salesforce org username credentials to connect to the target org. (Required)
@@ -465,6 +390,8 @@ FLAGS
     -f, --config=<value>          The path to the directory containing configurations to import. (Required)
     -l, --logs                    Use it to get a more detailed log of migration process. (Optional)
     -c, --clone                   Use this flag to disables the update of existing docconfigs and allows to create new ones. (Optional)
+    --session=<value>            This flag is used to provide a Salesforce Session ID for authentication.
+    --instance=<value>           This flag specifies the Salesforce Instance URL. The Instance URL corresponds to the specific Salesforce environment (e.g., production, sandbox) you are connecting to.
 
 DESCRIPTION
     Import DocConfigs and related DataSource files into your organization.
@@ -531,6 +458,318 @@ FLAG DESCRIPTIONS
 
     -c, --clone
         Use this flag to disables the update of existing docconfigs and allows to create new ones. (Optional)
+
+    --session
+        This flag is used to provide a Salesforce Session ID for authentication.
+    
+    --instance
+        This flag specifies the Salesforce Instance URL. The Instance URL corresponds to the specific Salesforce environment (e.g., production, sandbox) you are connecting to.
+```
+
+## butler pb exportpack
+
+<span style="color: red;">Important!</span> Make sure you have installed PDF Butler version equal or higher than v1.440. <br/>
+
+Export PDF Butler Pack.
+
+```
+USAGE
+$ sf butler pb exportpack [--target | -t <value>] [--pack | -p <value>] [--out | -o <value>] [--logs | -l] [--session <value>] [--instance <value>]
+
+FLAGS
+    -t, --target=<value>         The Salesforce org username credentials to connect to the target org. (Required)
+    -p, --pack=<value>             The Customer Pack Id of the PDF Butler Pack to export.
+                                 For bulk export, enter multiple Customer Pack Ids separated by commas.  (Required)
+    -o, --out=<value>            The value specifies the path to the folder with the exported configuration and archive name. (Required)
+    -l, --logs                    Use it to get a more detailed log of migration process. (Optional)
+    --session=<value>            This flag is used to provide a Salesforce Session ID for authentication.
+    --instance=<value>           This flag specifies the Salesforce Instance URL. The Instance URL corresponds to the specific Salesforce environment (e.g., production, sandbox) you are connecting to.
+
+DESCRIPTION
+    Export PDFButler Pack with related DocConfig, DataSources and Actionables from your organization.
+
+    You must run this command from the termianl.
+
+    By default, all your exported data is stored in a json file.
+
+    To initiate an export, ensure you specify the necessary parameters, including the target org, Customer Pack Id and output path.
+
+EXAMPLES
+    Export single pack:
+
+        $ sf butler pb exportpack -t sfusername@sandbox.com -p 'customer_pack_id'
+            -o 'export_folder_name/folder_name' -l
+
+        # Console output:
+            [INFO] Username: "sfusername@sandbox.com"
+            [INFO] Packs to retrieve: "customer_pack_id"
+            [INFO] Directory to output: "export_folder_name/folder_name"
+            [INFO] Try to connect to the org
+            [INFO] Connected to sfusername@sandbox.com (session_id) with API version 62.0
+            [INFO] Try to export pack by Id: customer_pack_id
+            [INFO] Calling the service...
+            [INFO] Saving to the directory
+            [INFO] Directory hierarchy: ./export_folder_name/folder_name/sfdc
+            [INFO] File path: ./export_folder_name/folder_name/sfdc/customer_pack_id.json
+            [INFO] Data successfully written to ./export_folder_name/folder_name/sfdc/customer_pack_id.json
+
+        # Created:
+            Directory 'export_folder_name/folder_name/sfdc'{
+                file 'customer_pack_id.json'
+            }
+    
+    Export multiple packs:
+
+        $ sf butler pb exportpack -t sfusername@sandbox.com -p 'customer_pack_id1, customer_pack_id2'
+            -o 'export_folder_name/folder_name' -l
+
+        # Console output:
+            [INFO] Username: "sfusername@sandbox.com"
+            [INFO] Packs to retrieve: "customer_pack_id1, customer_pack_id12"
+            [INFO] Directory to output: "export_folder_name/folder_name"
+            [INFO] Try to connect to the org
+            [INFO] Connected to sfusername@sandbox.com (session_id) with API version 62.0
+            [INFO] Try to export pack by Id: customer_pack_id1
+            [INFO] Calling the service.
+            [INFO] Saving to the directory
+            [INFO] Directory hierarchy: ./export_folder_name/folder_name/sfdc
+            [INFO] File path: ./export_folder_name/folder_name/sfdc/customer_pack_id1.json
+            [INFO] Data successfully written to ./export_folder_name/folder_name/sfdc/customer_pack_id1.json
+            [INFO] Try to export pack by Id: customer_pack_id12
+            [INFO] Calling the service.
+            [INFO] Saving to the directory
+            [INFO] Directory hierarchy: ./export_folder_name/folder_name/sfdc
+            [INFO] File path: ./export_folder_name/folder_name/sfdc/customer_pack_id12.json
+            [INFO] Data successfully written to ./ -/sfdc/customer_pack_id12.json
+
+        # Created:
+            Directory 'export_folder_name/folder_name/sfdc'{
+                file 'customer_pack_id1.json'
+                file 'customer_pack_id2.json'
+            }
+
+FLAG DESCRIPTIONS
+    -t, --target <value>
+        Specifies the Salesforce org username credentials to connect to the target
+        org from where the PDF Butler packs will be exported. This flag is required for authentication.
+
+    -p, --pack <value>
+        Specifies the Customer Pack Id of the PDF Butler Pack to be exported.
+        This ID uniquely identifies the pack you want to export. It is a required parameter.
+
+    -o, --out <value>
+        Specifies the path to the directory where to export packs. This flag is required.
+
+    -l, --logs
+        Use it to get a more detailed log of migration process.
+
+    --session
+        This flag is used to provide a Salesforce Session ID for authentication.
+    
+    --instance
+        This flag specifies the Salesforce Instance URL. The Instance URL corresponds to the specific Salesforce environment (e.g., production, sandbox) you are connecting to.
+```
+
+## butler pb importpack
+
+<span style="color: red;">Important!</span> Make sure you have installed PDF Butler version equal or higher than v1.440. <br/>
+
+Import PDF Butler Pack.
+
+```
+USAGE
+$ sf butler pb importpack [--target | -t <value>] [--pack | -p <value>] [--folder | -f <value>] [-logs | -l] [--session <value>] [--instance <value>]
+
+FLAGS
+    -t, --target=<value>         The Salesforce org username credentials to connect to the target org. (Required)
+    -p, --pack=<value>             The Customer Pack Id of the PDF Butler Pack to export.
+                                 For bulk export, enter multiple Customer Pack Ids separated by commas.  (Required)
+    -f, --folder=<value>            The value specifies the path to the folder with the exported packs. (Required)
+    -l, --logs                    Use it to get a more detailed log of migration process. (Optional)
+    --session=<value>            This flag is used to provide a Salesforce Session ID for authentication.
+    --instance=<value>           This flag specifies the Salesforce Instance URL. The Instance URL corresponds to the specific Salesforce environment (e.g., production, sandbox) you are connecting to.
+
+DESCRIPTION
+    Import PDFButler Pack with related DocConfig, DataSources and Actionables into your organization.
+
+    You must run this command from the termianl.
+
+    To initiate an import, ensure you specify the necessary parameters, including the target org, Customer Pack Id and folder path.
+
+EXAMPLES
+    import single pack:
+
+        $ sf butler pb importpack -t sfusername@sandbox.com -p 'customer_pack_id'
+            -f 'export_folder_name/folder_name/sfdc' -l
+
+        # Console output:
+            [INFO] Username: "sfusername@sandbox.com"
+            [INFO] Packs to import: "customer_pack_id1"
+            [INFO] Folder to retrieve: "export_folder_name/folder_name/sfdc"
+            [INFO] Try to connect to the org
+            [INFO] Connected to sfusername@sandbox.com (session_id) with API version 62.0
+            [INFO] Retrieving items from the directory
+            [INFO] Files found in folder: 1
+            [INFO] Successfully imported  export_folder_name/folder_name/sfdc/customer_pack_id1.json
+    
+    Import multiple packs:
+
+        $ sf butler pb importpack -t sfusername@sandbox.com -p 'customer_pack_id1, customer_pack_id2'
+            -f 'export_folder_name/folder_name' -l
+
+        # Console output:
+            [INFO] Username: "sfusername@sandbox.com"
+            [INFO] Packs to import: "customer_pack_id1, customer_pack_id2"
+            [INFO] Folder to retrieve: "export_folder_name/folder_name/sfdc"
+            [INFO] Try to connect to the org
+            [INFO] Connected to sfusername@sandbox.com (session_id) with API version 62.0
+            [INFO] Retrieving items from the directory
+            [INFO] Files found in folder: 2
+            [INFO] Successfully imported  export_folder_name/folder_name/sfdc/customer_pack_id1.json
+            [INFO] Successfully imported  export_folder_name/folder_name/sfdc/customer_pack_id2.json
+
+FLAG DESCRIPTIONS
+    -t, --target <value>
+        Specifies the Salesforce org username credentials to connect to the target
+        org where the PDF Butler packs will be imported. This flag is required for authentication.
+
+    -p, --pack <value>
+        Specifies the unique Customer Pack Id of the PDF Butler Pack to be imported.
+        This ID uniquely identifies the packs you want to import. It is a required parameter.
+
+    -f, --folder <value>
+        Specifies the path to the directory containing packs to import.
+        This flag is required to determine which paksc to import.
+
+    -l, --logs
+        Use it to get a more detailed log of migration process.
+
+    --session
+        This flag is used to provide a Salesforce Session ID for authentication.
+    
+    --instance
+        This flag specifies the Salesforce Instance URL. The Instance URL corresponds to the specific Salesforce environment (e.g., production, sandbox) you are connecting to.
+```
+
+## butler pb adminsettings
+
+<span style="color: red;">Important!</span> Make sure you have installed PDF Butler version equal or higher than v1.440. <br/>
+
+Provide PDF Butler App Settings.
+
+```
+USAGE
+$ sf butler pb adminsettings [--target | -t <value>] [--url | -u <value>] [--region | -r <value>] [--stage | -s <value>] [--session <value>] [--instance <value>]
+
+FLAGS
+    -t, --target=<value>         The Salesforce org username credentials to connect to the target org. (Required)
+    -u, --url=<value>             The Cadmus Endpoint to set. (Required)
+    -r, --region=<value>            The value specifies the region of PDF Butler account. (Required)
+    -s, --stage=<value>            The value specifies the stage of the organisation. (Required)
+    --session=<value>            This flag is used to provide a Salesforce Session ID for authentication.
+    --instance=<value>           This flag specifies the Salesforce Instance URL. The Instance URL corresponds to the specific Salesforce environment (e.g., production, sandbox) you are connecting to.
+
+DESCRIPTION
+    Allows you to configure critical PDFButler settings such as the service URL, region, and stage.
+
+    You must run this command from the termianl.
+
+EXAMPLES
+    Set settings:
+
+        $ sf butler pb adminsettings -t sfusername@sandbox.com -u 'https://us1.pdfbutler.com'
+            -r 'LOCAL' -s 'TEST'
+
+        # Console output:
+            [INFO] Authenticating user: sfusername@sandbox.com
+            [INFO] Connected to sfusername@sandbox.com (Org ID: org_id)
+            [INFO] Sending data to ***:
+            {
+                "url":"https://us1.pdfbutler.com/",
+                "region":"LOCAL",
+                "stage":"TEST"
+            }
+            [INFO] Successfully imported settings.
+
+FLAG DESCRIPTIONS
+    -t, --target <value>
+        Specifies the Salesforce org username credentials to connect to the target
+        org where the settings will be setuped. This flag is required for authentication.
+
+    -u, --url <value>
+        The base URL for the PDFButler service.
+
+    -r, --region <value>
+        Specifies the geographic region for the service (e.g., EU, US).
+
+    -s, --stage <value>
+        The deployment stage (e.g., dev, staging, production).
+
+    --session
+        This flag is used to provide a Salesforce Session ID for authentication.
+    
+    --instance
+        This flag specifies the Salesforce Instance URL. The Instance URL corresponds to the specific Salesforce environment (e.g., production, sandbox) you are connecting to.
+```
+
+## butler pb admincredentials
+
+<span style="color: red;">Important!</span> Make sure you have installed PDF Butler version equal or higher than v1.440. <br/>
+
+Setup the PDF Butler Admin Credentials.
+
+```
+USAGE
+$ sf butler pb admincredentials [--target | -t <value>] [--username | -u <value>] [--password | -p <value>] [--user-password <value>] [--session <value>] [--instance <value>]
+
+FLAGS
+    -t, --target=<value>         The Salesforce org username credentials to connect to the target org. (Required)
+    -u, --username=<value>             The admin username for PDFButler. (Required)
+    -p, --password=<value>            The admin password for PDFButler. (Required)
+    --user-password=<value>            The user password for PDFButler. (Required)
+    --session=<value>            This flag is used to provide a Salesforce Session ID for authentication.
+    --instance=<value>           This flag specifies the Salesforce Instance URL. The Instance URL corresponds to the specific Salesforce environment (e.g., production, sandbox) you are connecting to.
+
+DESCRIPTION
+    Enables you to securely provide or update the PDFButler admin credentials.
+
+    You must run this command from the termianl.
+
+EXAMPLES
+    Set settings:
+
+        $ sf butler pb admincredentials -t sfusername@sandbox.com -u 'username' 
+             -p 'ADMIN_password' --user-password 'USER_password' -l
+
+        # Console output:
+            [INFO] Authenticating user: sfusername@sandbox.com
+            [INFO] Connected to sfusername@sandbox.com (Org ID: org_id)
+            [INFO] Sending data to endpoint: {
+                "username": "sfusername@sandbox.com",
+                "password": "ADMIN_password",
+                "userPassword": "USER_password"
+            }
+            [INFO] Successfully imported user credentials.
+
+FLAG DESCRIPTIONS
+    -t, --target <value>
+        Specifies the Salesforce org username credentials to connect to the target
+        org where the settings will be setuped. This flag is required for authentication.
+
+    -u, --username <value>
+        The admin username for PDFButler
+
+    -p, --password <value>
+        The admin password for PDFButler.
+
+    --user-password <value>
+        The user password for PDFButler.
+
+    --session
+        This flag is used to provide a Salesforce Session ID for authentication.
+    
+    --instance
+        This flag specifies the Salesforce Instance URL. The Instance URL corresponds to the specific Salesforce environment (e.g., production, sandbox) you are connecting to.
 ```
 
 ## Typical errors and solutions

package/lib/commands/butler/pb/admincredentials.d.ts

@@ -0,0 +1,24 @@
+import { SfCommand } from '@salesforce/sf-plugins-core';
+export type ButlerPbAdmincredentialsResult = {
+    success: boolean;
+};
+export default class ButlerPbAdmincredentials extends SfCommand<ButlerPbAdmincredentialsResult> {
+    static readonly summary: string;
+    static readonly description: string;
+    static readonly examples: string[];
+    static readonly flags: {
+        name: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
+        target: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
+        username: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
+        password: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
+        'user-password': import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
+        session: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
+        instance: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
+    };
+    private static log;
+    private static isBlank;
+    private static authenticateWithTarget;
+    private static authenticateWitsSession;
+    private static authenticate;
+    run(): Promise<ButlerPbAdmincredentialsResult>;
+}