|
| 1 | +:template: product-landing |
| 2 | +:hidefeedback: header |
1 | 3 | :noprevnext:
|
2 | 4 |
|
3 |
| -.. _mcli: |
| 5 | +================= |
| 6 | +What is mongocli? |
| 7 | +================= |
4 | 8 |
|
5 |
| -====================================================== |
6 |
| -{+mcli-long+} |
7 |
| -====================================================== |
| 9 | +.. introduction:: |
8 | 10 |
|
9 |
| -.. default-domain:: mongodb |
| 11 | + The {+mcli+} is a modern command line interface that enables you to manage |
| 12 | + your MongoDB services from the terminal. |
10 | 13 |
|
11 |
| -.. contents:: On this page |
12 |
| - :local: |
13 |
| - :backlinks: none |
14 |
| - :depth: 1 |
15 |
| - :class: singlecol |
| 14 | + .. button:: Install {+mcli+} |
| 15 | + :uri: https://www.mongodb.com/try/download/mongocli |
16 | 16 |
|
17 |
| -The {+mcli-long+} allows you to create and manage MongoDB Cloud |
18 |
| -deployments with |service-fullname|. You can also use the {+mcli+} to |
19 |
| -manage your on-premises MongoDB environments with |cloud| and |
20 |
| -|mms-full|. With the {+mcli+}, you can quickly interact with MongoDB |
21 |
| -services from the command line for easier testing and scripting. |
| 17 | + :doc:`View installation instructions </install>` |
22 | 18 |
|
23 |
| -:ref:`mcli-install` |
24 |
| - Install the {+mcli+} by using GitHub or downloading a binary. |
| 19 | +.. image:: /images/hero.png |
| 20 | + :alt: Homepage hero image |
25 | 21 |
|
26 |
| -:ref:`mcli-configure` |
27 |
| - Configure {+mcli+} settings through the command line, configuration |
28 |
| - file, or environment variables. |
| 22 | +.. kicker:: What You Can Do |
29 | 23 |
|
30 |
| -:ref:`Command Reference <mongocli>` |
31 |
| - Review the {+mcli+} commands and options. |
| 24 | +Manage your Deployment from the Command Line |
| 25 | +-------------------------------------------- |
32 | 26 |
|
33 |
| -:ref:`mcli-reference` |
34 |
| - Reference material for {+mcli+} components. |
| 27 | +Use simple, one-line commands to interact with MongoDB |service|, |
| 28 | +|cloud-short|, or |onprem|, and to automate management tasks for your deployments. |
35 | 29 |
|
36 |
| -:ref:`mcli-troubleshooting` |
37 |
| - Review advice for common issues. |
| 30 | +.. tabs:: |
38 | 31 |
|
39 |
| -:ref:`Release Notes <mcli-release-notes>` |
40 |
| - Review the changelogs and notes for {+mcli+} releases. |
| 32 | + .. tab:: Configure the {+mcli+} |
| 33 | + :tabid: configure |
41 | 34 |
|
42 |
| -:ref:`mcli-third-party-licenses` |
43 |
| - Review third-party licenses. |
| 35 | + .. procedure:: |
| 36 | + |
| 37 | + .. step:: Create API Keys |
| 38 | + |
| 39 | + In the |service| UI, create an API key to programmatically access |
| 40 | + your organization or project. |
| 41 | + |
| 42 | + :ref:`To learn more, see Configure Atlas API Access <atlas-prog-api-key>` |
| 43 | + |
| 44 | + .. step:: Create a Project |
| 45 | + |
| 46 | + If you don't have an existing project, create one to group clusters |
| 47 | + that share users, settings, or environments. |
| 48 | + |
| 49 | + :atlas:`To learn more, see Create a Project </tutorial/manage-projects/#std-label-create-project>` |
| 50 | + |
| 51 | + .. step:: Create a Profile |
| 52 | + |
| 53 | + Store your API keys, organization and project IDs, and other |
| 54 | + settings in a profile to easily access your MongoDB deployments. |
| 55 | + |
| 56 | + :ref:`To learn more, see Configure the {+mcli+} <mcli-configure>` |
| 57 | + |
| 58 | + .. image:: /images/config.gif |
| 59 | + :alt: MongoDB CLI config command |
| 60 | + |
| 61 | + .. tab:: Create a Cluster with One Command |
| 62 | + :tabid: create-cluster |
| 63 | + |
| 64 | + .. procedure:: |
| 65 | + |
| 66 | + .. step:: Quick Start |
| 67 | + |
| 68 | + Create, configure and connect to an |service| cluster in one command. |
| 69 | + |
| 70 | + :ref:`To learn more, see Get Started with MongoDB Atlas <mcli-quick-start-atlas>` |
| 71 | + |
| 72 | + .. image:: /images/quickstart.gif |
| 73 | + :alt: MongoDB CLI quickstart command |
| 74 | + |
| 75 | +.. kicker:: Related Products & Resources |
| 76 | + |
| 77 | +Go Further with the {+mcli+} |
| 78 | +------------------------------- |
| 79 | + |
| 80 | +Explore advanced features of the {+mcli+} and the MongoDB services you can |
| 81 | +interact with. |
| 82 | + |
| 83 | +.. card-group:: |
| 84 | + :columns: 3 |
| 85 | + :style: compact |
| 86 | + |
| 87 | + .. card:: |
| 88 | + :cta: Read Atlas docs |
| 89 | + :url: https://docs.atlas.mongodb.com/getting-started/ |
| 90 | + :icon: /images/icons/atlas.svg |
| 91 | + :icon-alt: MongoDB Atlas icon |
| 92 | + |
| 93 | + Interact with your cloud deployments through a GUI |
| 94 | + |
| 95 | + .. card:: |
| 96 | + :cta: Read Reference Docs |
| 97 | + :url: https://docs.mongodb.com/mongocli/stable/command/mongocli/ |
| 98 | + :icon: /images/icons/mcli.svg |
| 99 | + :icon-alt: MongoCLI icon |
| 100 | + |
| 101 | + Explore more advanced {+mcli+} use cases |
| 102 | + |
| 103 | + .. card:: |
| 104 | + :cta: Read Troubleshooting Docs |
| 105 | + :url: https://docs.mongodb.com/mongocli/stable/troubleshooting/ |
| 106 | + :icon: /images/icons/mcli.svg |
| 107 | + :icon-alt: MongoCLI icon |
| 108 | + |
| 109 | + Review common error messages and issues |
44 | 110 |
|
45 | 111 | .. toctree::
|
46 | 112 | :titlesonly:
|
47 | 113 |
|
| 114 | + Overview </index> |
48 | 115 | /install
|
49 | 116 | /configure
|
50 | 117 | /quick-start
|
51 | 118 | Command Reference </command/mongocli>
|
52 | 119 | /reference
|
53 | 120 | /troubleshooting
|
54 | 121 | Release Notes </release-notes>
|
55 |
| - /third-party-licenses |
56 |
| - |
| 122 | + /third-party-licenses |
0 commit comments