Skip to content

Commit fefd094

Browse files
authored
(DOCSP-21311) New file name and location for mcli config file (#685)
* (DOCSP-21311) New file name and location for mcli config file * Includes changes from copy review
1 parent 6bb3326 commit fefd094

File tree

2 files changed

+35
-9
lines changed

2 files changed

+35
-9
lines changed

source/configure.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ You can define the settings that the {+mcli+} uses to interact with
2424
MongoDB services like |service|, |cloud-short|, and |onprem| by using
2525
the :ref:`mongocli-auth-login` or :ref:`mongocli-config` command. The
2626
first time you run one of these commands, the {+mcli+} creates a
27-
:ref:`configuration file <mcli-config-file>` called ``mongocli.toml``
27+
:ref:`configuration file <mcli-config-file>` called ``config.toml``
2828
to store your settings.
2929

3030
Prerequisites

source/configure/configuration-file.txt

Lines changed: 34 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -22,14 +22,39 @@ Configuration File Location
2222
---------------------------
2323

2424
The first time you run the :ref:`mongocli-config` command, the
25-
{+mcli+} creates a configuration file called ``mongocli.toml``. The
25+
{+mcli+} creates a configuration file called ``config.toml``. The
2626
{+mcli+} grants the user who ran the command read and write access to
27-
the file. The {+mcli+} saves the configuration file to the folder where
28-
the system stores application configuration files, which is defined by
29-
the ``$XDG_CONFIG_HOME`` environment variable. By default, this location
30-
is the ``/.config`` folder of the user's home directory. If this folder
31-
doesn't exist, the {+mcli+} creates the folder and grants the user read,
32-
write, and execute permissions.
27+
the file. The {+mcli+} saves the configuration file to the following location
28+
depending on your operating system:
29+
30+
.. tabs-platforms::
31+
32+
.. tab::
33+
:tabid: macos
34+
35+
.. code-block::
36+
37+
/Users/{username}/Library/Application Support/mongocli
38+
39+
.. tab::
40+
:tabid: windows
41+
42+
.. code-block::
43+
44+
%AppData/mongocli
45+
46+
.. tab::
47+
:tabid: linux
48+
49+
.. code-block::
50+
51+
$XDG_CONFIG_HOME/mongocli
52+
53+
If ``$XDG_CONFIG_HOME`` is not set, the {+mcli+} uses:
54+
55+
.. code-block::
56+
57+
$HOME/.config/mongocli
3358

3459
.. _mcli-profiles:
3560

@@ -94,7 +119,8 @@ contains the following settings:
94119
.. code-block:: text
95120
:copyable: false
96121

97-
# ~/.config/mongocli.toml
122+
123+
$XDG_CONFIG_HOME/mongocli/config.toml
98124

99125
mongosh_path = "/usr/local/bin/mongosh"
100126

0 commit comments

Comments
 (0)