DOCSP-15141 Add support for MongoDB Shell to MongoDB CLI (#526)

* DOCSP-15141 Add support for MongoDB Shell to MongoDB CLI

* DOCSP-15141 updates for review feedback

Author: kanchana-mongodb

source/configure/configuration-file.txt

@@ -67,8 +67,8 @@ profile by the number of profiles you have configured:
 Example
 -------
 
-The following example configuration file contains two profiles,
-``default`` and ``myOpsManager``. 
+The following example configuration file contains the path to the 
+|mongo| shell and two profiles, ``default`` and ``myOpsManager``. 
 
 The ``default`` profile connects to an |service| deployment and contains
 the following settings:
@@ -95,6 +95,8 @@ contains the following settings:
 
    # ~/.config/mongocli.toml
 
+   mongosh_path = "/usr/local/bin/mongosh"
+
    [default]
      organization_id = "qwer5678uiop23jb45lk78mn"
      public_api_key = "ABCDEFG"

source/includes/config-set-properties.rst

@@ -17,6 +17,10 @@
    * - ``private_api_key`` 
      - Private key for programmatic access. 
 
+   * - ``mongosh_path`` 
+     - Path to the |mongo| shell on your system. The default value is 
+       ``/usr/local/bin/mongosh``.
+
    * - ``ops_manager_url`` 
      - **Ops Manager only.**  |mms| base URL. The |url| must end with a 
        forward slash (i.e. ``/``).

source/includes/steps-configure-mcli-atlas.yaml

@@ -24,6 +24,11 @@ source:
   ref: enter-projectid
 ---
 stepnum: 5
+source:
+  file: steps-configure-mcli.yaml
+  ref: enter-mongo-shell-path
+---
+stepnum: 6
 source:
   file: steps-configure-mcli.yaml
   ref: verify-profile

source/includes/steps-configure-mcli-cm.yaml

@@ -24,6 +24,11 @@ source:
   ref: enter-projectid
 ---
 stepnum: 5
+source:
+  file: steps-configure-mcli.yaml
+  ref: enter-mongo-shell-path
+---
+stepnum: 6
 source:
   file: steps-configure-mcli.yaml
   ref: verify-profile

source/includes/steps-configure-mcli-om.yaml

@@ -28,6 +28,11 @@ source:
   file: steps-configure-mcli.yaml
   ref: enter-projectid
 ---
+stepnum: 5
+source:
+  file: steps-configure-mcli.yaml
+  ref: enter-mongo-shell-path
+---
 stepnum: 6
 source:
   file: steps-configure-mcli.yaml

source/includes/steps-configure-mcli.yaml

@@ -79,7 +79,7 @@ content: |
   .. code-block:: sh
      :copyable: false
                
-     ? Public API Key: abcdef
+     ? Public API Key: [? for help] abcdef
      ? Private API Key: [? for help]
      ************************************
 
@@ -102,7 +102,7 @@ content: |
      .. code-block:: sh
         :copyable: false
 
-        ? Choose a default organization:  [Use arrows to move, type to filter]
+        ? Default Org ID:  [Use arrows to move, type to filter]
         > Org1 (5e39bf1212121e685774c81c)
 
   #. Press :kbd:`Enter`.
@@ -130,7 +130,7 @@ content: |
      .. code-block:: sh
         :copyable: false
 
-        ? Choose a default project:  [Use arrows to move, type to filter]
+        ? Default Project ID:  [Use arrows to move, type to filter]
           Project1 (5e5ebffd0c04a97009061234)
           Project2 (5cfacee6014b761b07f15678)
         > Project3 (5e39bf4979358e6857741212)
@@ -140,6 +140,26 @@ content: |
 
   If you didn't enter |api| keys, the command prompts you to enter your
   ``Default Project ID``.
+---
+title: "Specify the path to |mongo| shell on your system."
+stepnum: 0
+level: 4
+ref: enter-mongo-shell-path
+content: | 
+
+  {+mcli+} uses the |mongo| shell path that you specify to allow you to 
+  access your deployments. The default value is 
+  ``/usr/local/bin/mongosh``. Press :kbd:`Enter` to accept the default 
+  or: 
+
+  a. Specify the path to |mongo| shell on your system.
+
+     .. code-block:: sh 
+        :copyable: false 
+
+        ? Default MongoDB Shell Path: [? for help] (/usr/local/bin/mongosh)
+        
+  #. Press :kbd:`Enter`.
 
 ---
 title: "Verify your profile."
@@ -172,18 +192,21 @@ content: |
 
               mongocli config describe default
           
-           The command returns the following settings. For security
-           purposes, the command redacts |api| keys in the output.
+           The preceding command returns the following settings. For 
+           security purposes, the command redacts |api| keys in the 
+           output.
 
            .. code-block:: sh
               :copyable: false
               
+              SETTING           VALUE
+              mongosh_path      /usr/local/bin/mongosh
               {{opsMgrUrl}}
-              org_id = 5f1f39ffc902201990f12345
-              private_api_key = redacted
-              project_id = 7ehf04abc10defb66c7d1234c
-              public_api_key = redacted
-              service = {{serviceName}}
+              org_id            5f1f39ffc902201990f12345
+              private_api_key   redacted
+              project_id        7ehf04abc10defb66c7d1234c
+              public_api_key    redacted
+              service           {{serviceName}}
 
      .. tab:: Named Profile
         :tabid: named-profile
@@ -204,12 +227,13 @@ content: |
            .. code-block:: sh
               :copyable: false
               
+              SETTING           VALUE
               {{opsMgrUrl}}
-              org_id = 5f1f39ffc902201990f12345
-              private_api_key = redacted
-              project_id = 7ehf04abc10defb66c7d1234c
-              public_api_key = redacted
-              service = {{serviceName}}
+              org_id            5f1f39ffc902201990f12345
+              private_api_key   redacted
+              project_id        7ehf04abc10defb66c7d1234c
+              public_api_key    redacted
+              service           {{serviceName}}
 
 ---
 title: "Customize the {+mcli+} output using a Go template."

source/reference/config.txt

@@ -59,6 +59,11 @@ When you run the command, it prompts you for the following information:
      - ID of your project.
      - Optional.
 
+   * - Default MongoDB Shell Path 
+     - Path to |mongo| shell on your system. The default value is  
+       ``/usr/local/bin/mongosh``.
+     - Optional.
+
 {+mcli+} saves these settings as a profile in the :ref:`mcli-config-file`.
 
 .. _mcli-config-command-syntax:
@@ -143,10 +148,11 @@ The following examples use the ``mongocli config`` command to:
 
          ~ mongocli config
 
-         ? Public API Key: abcdefgh
+         ? Public API Key: [? for help] abcdefgh
          ? Private API Key: [? for help] ************************************
-         ? Choose a default organization: Org1 (5c815cc7d5ec13092a02a1b2)
-         ? Choose a default project: Project1 (5e5ebffd0c04a9700906c3d4)
+         ? Default Org ID: [? for help] 5c815cc7d5ec13092a02a1b2
+         ? Default Project ID: [? for help] 5e5ebffd0c04a9700906c3d4
+         ? Default MongoDB Shell Path: [? for help] /usr/local/bin/mongosh
 
       **Example 2** 
 
@@ -158,10 +164,11 @@ The following examples use the ``mongocli config`` command to:
 
          ~ mongocli config --profile Profile1
 
-         ? Public API Key: abcdefgh
+         ? Public API Key: [? for help] abcdefgh
          ? Private API Key: [? for help] ************************************
-         ? Choose a default organization: Org1 (5c815cc7d5ec13092a02a1b2)
-         ? Choose a default project: Project1 (5e5ebffd0c04a9700906c3d4)
+         ? Default Org ID: [? for help] Org1 (5c815cc7d5ec13092a02a1b2)
+         ? Default Project ID: [? for help] Project1 (5e5ebffd0c04a9700906c3d4)
+         ? Default MongoDB Shell Path: [? for help] (/usr/local/bin/mongosh)
 
    .. tab:: Cloud Manager
       :tabid: cloud-manager
@@ -176,10 +183,10 @@ The following examples use the ``mongocli config`` command to:
 
          ~ mongocli config --service cloud-manager
 
-         ? Public API Key: abcdefgh
+         ? Public API Key: [? for help] abcdefgh
          ? Private API Key: [? for help] ************************************
-         ? Choose a default organization: Org1 (5c815cc7d5ec13092a02a1b2)
-         ? Choose a default project: Project1 (5e5ebffd0c04a9700906c3d4)
+         ? Default Org ID: [? for help] Org1 (5c815cc7d5ec13092a02a1b2)
+         ? Default Project ID: [? for help] Project1 (5e5ebffd0c04a9700906c3d4)
 
       **Example 2** 
 
@@ -191,10 +198,10 @@ The following examples use the ``mongocli config`` command to:
 
          ~ mongocli config --service cloud-manager --profile Profile1
 
-         ? Public API Key: abcdefgh
+         ? Public API Key: [? for help] abcdefgh
          ? Private API Key: [? for help] ************************************
-         ? Choose a default organization: Org1 (5c815cc7d5ec13092a02a1b2)
-         ? Choose a default project: Project1 (5e5ebffd0c04a9700906c3d4)
+         ? Default Org ID: [? for help] Org1 (5c815cc7d5ec13092a02a1b2)
+         ? Default Project ID: [? for help] Project1 (5e5ebffd0c04a9700906c3d4)
 
    .. tab:: Ops Manager 
       :tabid: ops-manager
@@ -210,10 +217,10 @@ The following examples use the ``mongocli config`` command to:
          ~ mongocli config --service ops-manager
 
          ? URL to Access Ops Manager: https://mms.example.com:8080/
-         ? Public API Key: abcdefgh
+         ? Public API Key: [? for help] abcdefgh
          ? Private API Key: [? for help] ************************************
-         ? Choose a default organization: Org1 (5c815cc7d5ec13092a02a1b2)
-         ? Choose a default project: Project1 (5e5ebffd0c04a9700906c3d4)
+         ? Default Org ID: [? for help] Org1 (5c815cc7d5ec13092a02a1b2)
+         ? Default Project ID: [? for help] Project1 (5e5ebffd0c04a9700906c3d4)
 
       **Example 2**
 
@@ -226,7 +233,7 @@ The following examples use the ``mongocli config`` command to:
          mongocli config --service ops-manager --profile Profile1
 
          ? URL to Access Ops Manager: https://mms.example.com:8080/
-         ? Public API Key: abcdefgh
+         ? Public API Key: [? for help] abcdefgh
          ? Private API Key: [? for help] ************************************
-         ? Choose a default organization: Org1 (5c815cc7d5ec13092a02a1b2)
-         ? Choose a default project: Project1 (5e5ebffd0c04a9700906c3d4)
+         ? Default Org ID:[? for help]  Org1 (5c815cc7d5ec13092a02a1b2)
+         ? Default Project ID:[? for help]  Project1 (5e5ebffd0c04a9700906c3d4)

source/reference/mcli-config-set.txt

@@ -70,6 +70,7 @@ Options
        - Unique identifier of the project for ``project_id``
        - Public |api| key for ``public_api_key``
        - Private |api| key for ``private_api_key``
+       - Path to the |mongo| shell for ``mongosh_path``
        - |mms| base URL for ``ops_manager_url``
        - Full path to the CA certificate for
          ``ops_manager_ca_certificate``
@@ -97,6 +98,7 @@ where ``<property-name>`` can be:
 - ``project_id``
 - ``public_api_key``
 - ``private_api_key``
+- ``mongosh_path``
 - ``ops_manager_url``
 - ``ops_manager_ca_certificate``
 - ``ops_manager_skip_verify``
@@ -196,6 +198,23 @@ The previous command prints the following to the terminal:
 
    Updated prop 'private_api_key'
 
+Set Path for |mongo| Shell 
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The following example uses the ``mongocli config set`` command to 
+set the path for the |mongo| shell on the system: 
+
+.. code-block:: sh
+
+   mongocli config set mongosh_path /usr/local/bin/mongosh 
+
+The previous command prints the following output to the terminal:
+
+.. code-block:: sh 
+   :copyable: false
+
+   Updated property 'mongosh_path'
+
 Set Custom CA Certificate File
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~