@@ -57,11 +57,6 @@ configuration file.
57
57
* - .. option:: --exportConnections
58
58
- :ref:`Export <compass-export-connections-cli>` favorite connections.
59
59
60
- * - .. option:: --file <file>
61
- - Specify a file containing a :ref:`list of connections
62
- <compass-export-connections-cli>`. These connections are automatically
63
- available once |compass| starts.
64
-
65
60
* - .. option:: --help
66
61
- Show |compass| options.
67
62
@@ -75,6 +70,18 @@ configuration file.
75
70
Specify a passphrase to decrypt the :ref:`imported favorite
76
71
connections <compass-import-connections-cli-encrypted>` file.
77
72
73
+ * - .. option:: --showExampleConfig
74
+ - Provides an example |compass-short| configuration file.
75
+
76
+ * - .. option:: --trustedConnectionString
77
+ - Suppresses warnings about disallowed connection string properties and allows
78
+ automatic connection. Compass inspects the connection string passed in the
79
+ command line, and verifies whether the connection string contains parameters
80
+ that can result in a security risk.
81
+
82
+ Only set this option if you pass a known trusted connection string to
83
+ |compass-short|.
84
+
78
85
* - .. option:: --version
79
86
- Show |compass| version.
80
87
@@ -96,6 +103,10 @@ value in the :guilabel:`Settings` panel.
96
103
- Enable :ref:`automatic updates <enable-automatic-updates>`. Use
97
104
``--no-autoUpdates`` to disable automatic updates.
98
105
106
+ * - .. option:: --browserCommandForOIDCAuth
107
+ - Specifies a shell command to start the browser for OIDC authentication
108
+ when you connect to the server or log into your Atlas Cloud account.
109
+
99
110
* - .. option:: --enableFeedbackPanel
100
111
- Enable the feedback panel. Use ``--no-enableFeedbackPanel`` to disable
101
112
automatic updates.
@@ -114,11 +125,19 @@ value in the :guilabel:`Settings` panel.
114
125
115
126
To learn more, see :ref:`disable-shell`.
116
127
128
+ * - .. option:: --file <file>
129
+ - Specifies a file containing a :ref:`list of connections
130
+ <compass-export-connections-cli>` that are automatically
131
+ available once |compass| starts.
132
+
117
133
* - .. option:: --forceConnectionOptions
118
134
- .. include:: /includes/fact-force-connection-options.rst
119
135
120
136
To learn more, see :ref:`compass-force-connection-options`.
121
137
138
+ * - .. option:: --ignoreAdditionalCommandLineFlags
139
+ - Allows additional command line flags.
140
+
122
141
* - .. option:: --installURLHandlers
123
142
- Register |compass-short| as a handler for mongodb:// and mongodb+srv://
124
143
URLs.
@@ -138,23 +157,54 @@ value in the :guilabel:`Settings` panel.
138
157
139
158
To learn more, see :ref:`compass-configure-network-traffic`.
140
159
160
+ * - .. option:: --password
161
+ - Specifies a password for authentication to Compass and the MongoDB
162
+ deployment provided in the connection string.
163
+
164
+ Use in conjunction with :option:`--username`.
165
+
166
+ * - .. option:: --persistOIDCTokens
167
+ - Allows you to remain logged in when using the MongoDB OIDC authentication
168
+ mechanism for MongoDB server connections. Session tokens are encrypted and
169
+ stored using the system keychain.
170
+
141
171
* - .. option:: --protectConnectionStrings
142
172
- .. include:: /includes/fact-protect-connection-strings.rst
143
173
144
174
To learn more, see :ref:`compass-protect-connection-strings`.
145
175
176
+ * - .. option:: --protectConnectionStringsForNewConnections
177
+ - Sets connection strings for new connections as read-only by
178
+ default. Passwords in new connection strings display as
179
+ ``*****``.
180
+
181
+ If ``protectConnectionStringsForNewConnections`` is enabled,
182
+ |compass-short| disables the :guilabel:`Edit connection string`
183
+ option but doesn't prevent users from manually enabling the
184
+ option with the :guilabel:`Edit connection string` toggle.
185
+
146
186
* - .. option:: --readOnly
147
187
- Prevent users from performing write operations to your MongoDB deployment
148
188
through |compass-short|.
149
189
150
190
To learn more, see :ref:`compass-read-only`.
151
191
192
+ * - .. option:: --showInsights
193
+ - Enables performance insights for your schemas and queries.
194
+
195
+ To learn more, see :ref:`compass-performance-insights`.
196
+
152
197
* - .. option:: --showKerberosPasswordField
153
198
- Show or hide the Kerberos password field on the |compass-short|
154
199
connection form.
155
200
156
201
To learn more, see :ref:`compass-kerberos-password`.
157
202
203
+ * - .. option:: --showOIDCDeviceAuthFlow
204
+ - Enables device authorization flow for OIDC authentication on MongoDB server.
205
+ This enables a less secure authentication flow that can be used as a fallback
206
+ when browser-based authentication is unavailable.
207
+
158
208
* - .. option:: --theme
159
209
- Specify the |compass| UI theme. The supported themes are ``DARK``,
160
210
``LIGHT``, and ``OS_THEME``.
@@ -163,6 +213,12 @@ value in the :guilabel:`Settings` panel.
163
213
- Enable sending usage statistics. Use ``--no-trackUsageStatistics``
164
214
to disable sending usage statistics.
165
215
216
+ * - .. option:: --username
217
+ - Specifies a username for authentication to Compass and the MongoDB
218
+ deployment provided in the connection string
219
+
220
+ Optionally, use in conjuction with :option:`--password`.
221
+
166
222
.. include:: /includes/fact-configuration-options-executable.rst
167
223
168
224
Learn More
0 commit comments