Skip to content

Commit 5091225

Browse files
DOCSP-48590-connect-via-atlas-cli (#110)
1 parent 66885fe commit 5091225

5 files changed

+55
-10
lines changed

source/connect.txt

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -107,6 +107,14 @@ Create a Connection
107107

108108
.. include:: /includes/steps/starting-vsce-connect-with-advanced-connection-settings.rst
109109

110+
.. tab:: Connect with Atlas CLI
111+
:tabid: Connect with Atlas CLI
112+
113+
The :atlascli:`Atlas CLI </>` allows you to connect to both your
114+
local and Atlas deployments from MongoDB for VsCode. Before beginning,
115+
:atlascli:`install the Atlas CLI </install-atlas-cli/>`.
116+
117+
.. include:: /includes/steps-starting-vsce-connect-with-atlas-cli.rst
110118

111119
.. _vsce-connect-task-atlas-streams:
112120

source/includes/steps-open-mongodb-view.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: "In |vscode-short|, click the :guilabel:`MongoDB` icon in the :guilabel:`Activity Bar`"
2+
title: In |vscode-short|, click the :guilabel:`MongoDB` icon in the :guilabel:`Activity Bar`.
33
level: 4
44
ref: open-mongodb-view
55
content: |

source/includes/steps-starting-vsce-connect-with-advanced-connection-settings.yaml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ source:
44
file: steps-open-mongodb-view.yaml
55
ref: open-mongodb-view
66
---
7-
title: Open the |vsce| Overview page
7+
title: Open the |vsce| Overview page.
88
level: 4
99
ref: create-connection
1010
content: |
@@ -46,7 +46,7 @@ content: |
4646
.. include:: /includes/admonitions/tip-mongodb-command-palette.rst
4747
4848
---
49-
title: Open the Advanced Connection Settings Form
49+
title: Open the Advanced Connection Settings Form.
5050
level: 4
5151
ref: vsce-advanced-connection-settings
5252
content: |
@@ -59,7 +59,7 @@ content: |
5959
:alt: Image showing connections pane screen
6060
6161
---
62-
title: Enter your connection information
62+
title: Enter your connection information.
6363
ref: vsce-enter-connection-info
6464
content: |
6565
@@ -487,7 +487,7 @@ content: |
487487
tunnel. |vsce| cannot establish a connection
488488
to multiple servers across the same SSH tunnel.
489489
---
490-
title: "Specify additional options in the :guilabel:`Advanced` tab"
490+
title: Specify additional options in the :guilabel:`Advanced` tab.
491491
level: 4
492492
optional: true
493493
ref: connect-additional-options
@@ -554,5 +554,5 @@ content: |
554554
---
555555
ref: vsce-click-connect
556556
level: 4
557-
title: "Click :guilabel:`Connect`"
557+
title: Click :guilabel:`Connect`.
558558
...
Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
.. procedure::
2+
:style: normal
3+
4+
.. step:: Connect from the Atlas CLI.
5+
6+
In your terminal, run ``atlas auth login`` to authenticate with your
7+
Atlas login credentials. To learn more,
8+
see :atlascli:`Connect from the Atlas CLI </connect-atlas-cli/>`.
9+
10+
.. step:: Run the connection command.
11+
12+
Run ``atlas deployment connect`` in your terminal.
13+
14+
.. code-block::
15+
16+
atlas deployment connect
17+
18+
.. step:: Select your deployment.
19+
20+
Select the deployment you wish to connect to from your list of deployments.
21+
22+
.. step:: Select |vsce| as your connection method.
23+
24+
The Atlas CLI prompts you to select your connection method. Select
25+
**"vscode - MongoDB for VsCode"**.
26+
27+
.. step:: Open |vscode-short| and click the :guilabel:`MongoDB` icon in the :guilabel:`Activity Bar`.
28+
29+
.. figure:: /images/vsce-mongodb-extension-sidemenu.png
30+
:figwidth: 600px
31+
:alt: Image VSCode side bar menu.
32+
33+
You can view your connected deployment under :guilabel:`Connections`.
34+
35+
.. figure:: /images/vsce-expand-connections.png
36+
:figwidth: 600px
37+
:alt: Image showing connections pane

source/includes/steps-starting-vsce-connect-with-connection-string.yaml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ content: |
2424
:manual:`Connection String URI Format
2525
</reference/connection-string>`.
2626
---
27-
title: "Open the |vscode-short| Command Palette."
27+
title: Open the |vscode-short| Command Palette.
2828
level: 4
2929
ref: vsce-open-overview-page
3030
content: |
@@ -60,7 +60,7 @@ content: |
6060
:figwidth: 600px
6161
:alt: Select add connection with connection string
6262
63-
.. tab:: Open from Overview Page
63+
.. tab:: Open from Overview Page.
6464
:tabid: mdboverview
6565
6666
a. Perform the action described in the following table for your
@@ -90,7 +90,7 @@ content: |
9090
.. include:: /includes/admonitions/tip-mongodb-command-palette.rst
9191
9292
---
93-
title: "Paste your connection string into the Command Palette"
93+
title: Paste your connection string into the Command Palette.
9494
level: 4
9595
ref: vsce-connect-paste
9696
content: |
@@ -103,7 +103,7 @@ content: |
103103
but you won't be able to interact with data in your deployment.
104104
105105
---
106-
title: "Press the **Enter** or **Return** key"
106+
title: Press the **Enter** or **Return** key.
107107
level: 4
108108
ref: vsce-connect-enter
109109
...

0 commit comments

Comments
 (0)