Skip to content

Commit 0ae82cb

Browse files
macOS install instructions (#5)
* WIP * (DOCSP-10357): install macos instructions * Apply suggestions from code review Co-authored-by: jwilliams-mongo <[email protected]> * apply copy review edits Co-authored-by: jwilliams-mongo <[email protected]>
1 parent 2ba24d0 commit 0ae82cb

File tree

3 files changed

+80
-1
lines changed

3 files changed

+80
-1
lines changed

source/connect.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _mdb-shell-connect:
2+
13
=======================
24
Connect to a Deployment
35
=======================
Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
---
2+
source:
3+
file: steps-install-shell-base.yaml
4+
ref: navigate-dlc
5+
ref: navigate-dlc-macos
6+
---
7+
source:
8+
file: steps-install-shell-base.yaml
9+
ref: open-mdb-shell-page
10+
ref: open-mdb-shell-page-macos
11+
---
12+
title: "Download the installation archive."
13+
ref: download-archive
14+
level: 4
15+
content: |
16+
---
17+
title: "Extract the files from the downloaded archive."
18+
ref: extract-archive
19+
level: 4
20+
content: |
21+
22+
.. code-block::
23+
24+
tar -zxvf path/to/archive
25+
26+
Skip this step if your web browser automatically unzips the file as
27+
part of the download.
28+
---
29+
title: "Add the MongoDB Shell binary to your ``PATH`` environment
30+
variable."
31+
ref: add-shell-to-path
32+
level: 4
33+
content: |
34+
35+
You can either:
36+
37+
- Copy the |mdb-shell| binary into a directory listed in your ``PATH``
38+
variable, such as ``/usr/local/bin`` (Update
39+
``/path/to/mongosh`` with your installation directory as
40+
appropriate)
41+
42+
.. code-block:: sh
43+
44+
sudo cp /path/to/mongosh /usr/local/bin/
45+
46+
- Create a symbolic link to the |mdb-shell| binary from a directory listed in
47+
your ``PATH`` variable, such as ``/usr/local/bin`` (Update
48+
``/path/to/mongosh`` with your installation directory as
49+
appropriate):
50+
51+
.. code-block:: sh
52+
53+
sudo ln -s /path/to/mongosh /usr/local/bin/
54+
55+
...

source/index.txt

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,21 @@ download center.
2424
Download and Install the |mdb-shell|
2525
------------------------------------
2626

27+
Prerequisites
28+
~~~~~~~~~~~~~
29+
30+
To use the |mdb-shell|, you must have a MongoDB deployment to connect
31+
to.
32+
33+
- For a free cloud-hosted deployment, you can use
34+
`MongoDB Atlas <https://www.mongodb.com/cloud/atlas?tck=docs_vsce>`__.
35+
36+
- To learn how to run a local MongoDB deployment, see
37+
:manual:`Install MongoDB </installation/>`.
38+
39+
Procedure
40+
~~~~~~~~~
41+
2742
.. tabs-platforms::
2843

2944
.. tab::
@@ -34,13 +49,20 @@ Download and Install the |mdb-shell|
3449
.. tab::
3550
:tabid: macOS
3651

37-
Hello, I am macOS content.
52+
.. include:: /includes/steps/install-shell-macos.rst
3853

3954
.. tab::
4055
:tabid: linux
4156

4257
Hello, I am Linux (rpm / deb) content.
4358

59+
Connect to a MongoDB Deployment
60+
-------------------------------
61+
62+
Once you have installed the |mdb-shell| and added it to you system
63+
``PATH``, you can connect to a MongoDB deployment. To learn more, see
64+
:ref:`mdb-shell-connect`.
65+
4466
Multi-Line Operations in the |mdb-shell|
4567
----------------------------------------
4668

0 commit comments

Comments
 (0)