(DOCSP-12177): Add command helpers

Author: jeff-allen-mongo

source/includes/steps-install-shell-macos.yaml

@@ -24,7 +24,7 @@ source:
   ref: add-shell-to-path
 ref: add-shell-to-path-macos
 ---
-title: "Allow macOS to Run ``mongosh``."
+title: "Allow macOS to run ``mongosh``."
 ref: remove-quarantine-macos
 level: 4
 content: |

source/reference/access-mdb-shell-help.txt

@@ -108,6 +108,7 @@ Show Help for Specific Database Method
   The output resembles the following:
 
   .. code-block:: none
+     :copyable: false
 
        db.adminCommand({ serverStatus: 1 }):
 
@@ -218,7 +219,7 @@ Show Help for Specific Collection Method
 Show Additional Usage Details for a Collection Method
   To see additional usage details for a collection method in
   ``mongosh``, type the ``db.<collection>.<method>`` name without the
-  parenthesis (``()``) The following example returns
+  parenthesis (``()``). The following example returns
   details about the :method:`~db.collection.insertOne()` method:
 
   .. code-block:: javascript
@@ -291,3 +292,67 @@ the following commands:
 - ``ObjectId``
 - ``Symbol`` *(Deprecated)*
 - ``Timestamp``
+
+Command Helpers
+---------------
+
+``mongosh`` provides the following methods and commands to wrap
+certain database commands and obtain information on your deployment:
+
+.. list-table::
+   :header-rows: 1
+   :widths: 30 70
+
+   * - Help Methods and Commands
+     - Description
+
+   * - ``help``
+
+     - Show help.
+
+   * - :method:`db.help()`
+
+     - Show help for database methods.
+
+   * - :method:`db.\<collection\>.help() <db.collection.help>`
+
+     - Show help on collection methods. The ``<collection>`` can be the
+       name of an existing collection or a non-existing collection.
+
+   * - ``show dbs``
+
+     - Print a list of all databases on the server.
+
+       .. note::
+
+          ``show dbs`` is synonymous with ``show databases``.
+
+   * - ``use <db>``
+
+     - Switch current database to ``<db>``. The ``mongosh`` variable
+       ``db`` is set to the current database.
+
+   * - ``show collections``
+
+     - Print a list of all collections for current database
+
+   * - ``show users``
+
+     - Print a list of users for current database.
+
+   * - ``show roles``
+
+     - Print a list of all roles, both user-defined and built-in, for
+       the current database.
+
+   * - ``show profile``
+
+     - Print the five most recent operations that took 1 millisecond or
+       more. See documentation on the
+       :manual:`database profiler
+       </tutorial/manage-the-database-profiler>` for more information.d
+
+   * - ``load()``
+
+     - Execute a JavaScript file. See :doc:`/write-scripts` for more
+       information.