Skip to content

Commit 8dc763f

Browse files
(DOCSP-11251): Clarify that MongoDB Shell and mongosh are synonymous
1 parent 33caf21 commit 8dc763f

File tree

4 files changed

+26
-23
lines changed

4 files changed

+26
-23
lines changed
Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
.. admonition:: Beta
22
:class: note
33

4-
|mdb-shell| is currently available as a **Beta** release. The
5-
product, its features, and the corresponding documentation may
6-
change during the Beta stage.
4+
The |mdb-shell| (``mongosh``) is currently available as a **Beta**
5+
release. The product, its features, and the corresponding
6+
documentation may change during the Beta stage.

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -36,15 +36,15 @@ content: |
3636
3737
chmod +x /path/to/mongosh
3838
---
39-
title: "Add the MongoDB Shell binary to your ``PATH`` environment
39+
title: "Add the ``mongosh`` binary to your ``PATH`` environment
4040
variable."
4141
ref: add-shell-to-path
4242
level: 4
4343
content: |
4444
4545
You can either:
4646
47-
- Copy the |mdb-shell| binary into a directory listed in your ``PATH``
47+
- Copy the ``mongosh`` binary into a directory listed in your ``PATH``
4848
variable, such as ``/usr/local/bin`` (Update
4949
``/path/to/mongosh`` with your installation directory as
5050
appropriate)
@@ -53,9 +53,9 @@ content: |
5353
5454
sudo cp /path/to/mongosh /usr/local/bin/
5555
56-
- Create a symbolic link to the |mdb-shell| binary from a directory listed in
57-
your ``PATH`` variable, such as ``/usr/local/bin`` (Update
58-
``/path/to/mongosh`` with your installation directory as
56+
- Create a symbolic link to the ``mongosh`` binary from a directory
57+
listed in your ``PATH`` variable, such as ``/usr/local/bin``
58+
(Update ``/path/to/mongosh`` with your installation directory as
5959
appropriate):
6060
6161
.. code-block:: sh

source/index.txt

Lines changed: 15 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -14,17 +14,17 @@ MongoDB Shell
1414

1515
.. include:: /includes/admonitions/fact-mdb-shell-beta.rst
1616

17-
The |mdb-shell| is a fully functional JavaScript environment for
18-
interacting with MongoDB deployments. You can use the |mdb-shell| to
19-
test queries and operations directly with your database.
17+
The |mdb-shell|, ``mongosh``, is a fully functional JavaScript
18+
environment for interacting with MongoDB deployments. You can use the
19+
|mdb-shell| to test queries and operations directly with your database.
2020

21-
The |mdb-shell| is available as a standalone package in the MongoDB
21+
``mongosh`` is available as a standalone package in the MongoDB
2222
download center.
2323

2424
Download and Install the |mdb-shell|
2525
------------------------------------
2626

27-
To learn how to download and install the |mdb-shell|, see
27+
To learn how to download and install the ``mongosh`` binary, see
2828
:ref:`mdb-shell-install`.
2929

3030
Connect to a MongoDB Deployment
@@ -78,21 +78,24 @@ you had entered into the editor.
7878
The |mdb-shell| versus the Legacy ``mongo`` Shell
7979
-------------------------------------------------
8080

81-
The |mdb-shell| offers numerous advantages over the legacy
82-
:binary:`mongo <mongo>` shell, such as:
81+
The new MongoDB Shell, ``mongosh``, offers numerous
82+
advantages over the legacy :binary:`~bin.mongo` shell, such as:
8383

8484
- Improved syntax highlighting.
8585

8686
- Improved command history.
8787

8888
- Improved logging.
8989

90-
During the beta stage, the |mdb-shell| supports a subset of the legacy
91-
:binary:`mongo <mongo>` shell commands. Extending the |mdb-shell| |api|
92-
coverage is an ongoing effort.
90+
During the beta stage, ``mongosh`` supports a subset of the
91+
:binary:`~bin.mongo` shell methods. Achieving feature parity between
92+
``mongosh`` and the ``mongo`` shell is an ongoing effort.
9393

94-
The commands that the |mdb-shell| supports use the same syntax as the
95-
corresponding commands in the legacy :binary:`mongo <mongo>` shell.
94+
To maintain backwards compatibility, the methods that ``mongosh``
95+
supports use the same syntax as the corresponding methods in the
96+
:binary:`~bin.mongo` shell. To see the complete list of methods
97+
supported by ``mongosh``, see
98+
:doc:`MongoDB Shell Methods </reference/methods>`.
9699

97100
Learn More
98101
----------

source/install.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
.. _mdb-shell-install:
22

3-
=======================
4-
Install the |mdb-shell|
5-
=======================
3+
===================
4+
Install ``mongosh``
5+
===================
66

77
.. default-domain:: mongodb
88

0 commit comments

Comments
 (0)