|
| 1 | +:template: product-landing |
| 2 | +:hidefeedback: header |
1 | 3 | :noprevnext:
|
2 | 4 |
|
3 | 5 | .. _atlascli:
|
4 | 6 |
|
5 |
| -============ |
6 |
| -{+atlas-cli+} |
7 |
| -============ |
| 7 | +========================== |
| 8 | +What is the {+atlas-cli+}? |
| 9 | +========================== |
8 | 10 |
|
9 |
| -.. contents:: On this page |
10 |
| - :local: |
11 |
| - :backlinks: none |
12 |
| - :depth: 2 |
13 |
| - :class: singlecol |
| 11 | +.. introduction:: |
14 | 12 |
|
15 |
| -The {+atlas-cli+} is a command line interface built specifically for |service|. |
16 |
| -After you install and configure the {+atlas-cli+}, you can manage |service| |
17 |
| -{+database-deployments+} from the terminal with: |
| 13 | + The {+atlas-cli+} is a command line interface built specifically for |
| 14 | + |service-fullname|. Interact with your |service| |
| 15 | + {+database-deployments+} and Atlas Search from the terminal with |
| 16 | + short, intuitive commands, so you can accomplish complex database management tasks in seconds. |
18 | 17 |
|
19 |
| -- Short, intuitive commands. While you can use ``curl`` commands to access the |
20 |
| - |service| APIs from the terminal, {+atlas-cli+} commands are much shorter. |
21 |
| -- Fewer system resources. Managing |service| from the terminal requires less |
22 |
| - available random access memory (RAM) and CPU processing time than the |service| UI. |
| 18 | + .. button:: Install the {+atlas-cli+} |
| 19 | + :uri: https://www.mongodb.com/docs/atlas/cli/stable/install-atlas-cli/ |
23 | 20 |
|
24 |
| -.. include:: /includes/fact-use-mongocli-for-om-cm.rst |
| 21 | + Then, run ``atlas setup`` |
25 | 22 |
|
26 |
| -Follow these steps to get started using the {+atlas-cli+}: |
| 23 | +.. image:: /images/hero.png |
| 24 | + :alt: Homepage hero image |
27 | 25 |
|
28 |
| -1. :ref:`Install the {+atlas-cli+} <install-atlas-cli>` |
29 |
| -2. :ref:`Connect from the {+atlas-cli+} <connect-atlas-cli>` |
30 |
| -3. :ref:`See tutorials to manage Atlas from the {+atlas-cli+} |
31 |
| - <atlas-cli-tutorials>` or |
32 |
| - :doc:`Go straight to the {+atlas-cli+} commands </command/atlas>` |
| 26 | +.. kicker:: What You Can Do |
| 27 | + |
| 28 | +Manage Atlas from the Command Line |
| 29 | +---------------------------------- |
| 30 | + |
| 31 | +Get started quickly with two commands: |
| 32 | + |
| 33 | +.. tabs:: |
| 34 | + |
| 35 | + .. tab:: Install the {+atlas-cli+} |
| 36 | + :tabid: install |
| 37 | + |
| 38 | + .. procedure:: |
| 39 | + |
| 40 | + .. step:: Run ``brew install mongodb-atlas-cli`` |
| 41 | + |
| 42 | + See our :ref:`documentation <install-atlas-cli>` for more |
| 43 | + ways to install the {+atlas-cli+}. |
| 44 | + |
| 45 | + .. image:: /images/install.gif |
| 46 | + :alt: brew install mongodb-atlas-cli command |
| 47 | + |
| 48 | + .. tab:: Set Up Atlas |
| 49 | + :tabid: setup |
| 50 | + |
| 51 | + .. procedure:: |
| 52 | + |
| 53 | + .. step:: Run ``atlas setup`` |
| 54 | + |
| 55 | + ``atlas setup`` does all of the following with one command: |
| 56 | + |
| 57 | + 1. Signs up for an |service| account. |
| 58 | + #. Authenticates with the new |service| account. |
| 59 | + #. Creates one free database. |
| 60 | + #. Loads :atlas:`sample data |
| 61 | + </sample-data/available-sample-datasets/>` |
| 62 | + into your |service| database. |
| 63 | + #. Adds your IP address to your project's IP access list. |
| 64 | + #. Creates a MongoDB user for your |service| |
| 65 | + {+database-deployment+}. |
| 66 | + #. Connect to your new {+database-deployment+} using the |
| 67 | + MongoDB Shell, {+mongosh+}. |
| 68 | + |
| 69 | + To learn more, see the :doc:`atlas setup documentation </command/atlas-setup>`. |
| 70 | + |
| 71 | + .. image:: /images/setup.gif |
| 72 | + :alt: atlas setup command |
| 73 | + |
| 74 | + |
| 75 | +.. kicker:: Related Products & Resources |
| 76 | + |
| 77 | +Go Further with the {+atlas-cli+} |
| 78 | +--------------------------------- |
| 79 | + |
| 80 | +Learn the {+atlas-cli+} commands and optimize your workflow with advanced tutorials and more. |
| 81 | + |
| 82 | +.. card-group:: |
| 83 | + :columns: 3 |
| 84 | + :style: compact |
| 85 | + |
| 86 | + .. card:: |
| 87 | + :cta: See All Commands |
| 88 | + :url: https://www.mongodb.com/docs/atlas/cli/stable/command/atlas/ |
| 89 | + :icon: /images/icons/card1.svg |
| 90 | + :icon-alt: AtlasCLI Commands Icon |
| 91 | + |
| 92 | + Discover new {+atlas-cli+} commands |
| 93 | + |
| 94 | + .. card:: |
| 95 | + :cta: View All Tutorials |
| 96 | + :url: https://www.mongodb.com/docs/atlas/cli/stable/atlas-cli-tutorials/ |
| 97 | + :icon: /images/icons/card2.svg |
| 98 | + :icon-alt: Tutorials Icon |
| 99 | + |
| 100 | + Explore {+atlas-cli+} workflows with guided tutorials |
| 101 | + |
| 102 | + .. card:: |
| 103 | + :cta: Read Release Notes |
| 104 | + :url: https://www.mongodb.com/docs/atlas/cli/stable/atlas-cli-changelog/ |
| 105 | + :icon: /images/icons/card3.svg |
| 106 | + :icon-alt: Atlas Icon |
| 107 | + |
| 108 | + Learn what's new in the {+atlas-cli+} |
33 | 109 |
|
34 | 110 | .. toctree::
|
35 | 111 | :titlesonly:
|
|
0 commit comments