Skip to content

Commit a927700

Browse files
DOCSP-38420 Add compass command line options (#622)
* DOCSP-38420 add commands * DOCSP-38420 add more commands * DOCSP-38420 anna feedback * DOCSP-38420 anna feedback * DOCSP-38420 missed change * DOCSP-38420 internal feedback * DOCSP-38420 internal feedback * DOCSP-38420 typo
1 parent 731a762 commit a927700

File tree

2 files changed

+62
-6
lines changed

2 files changed

+62
-6
lines changed
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
Sets all connection strings as read-only. Passwords in connection
22
strings display as ``*****``.
33

4-
If ``protectConnctionStrings`` is enabled, |compass-short| disables the
4+
If ``protectConnectionStrings`` is enabled, |compass-short| disables the
55
:guilabel:`Edit connection string` option and hides the
66
:guilabel:`Edit connection string` toggle.

source/settings/command-line-options.txt

Lines changed: 61 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -57,11 +57,6 @@ configuration file.
5757
* - .. option:: --exportConnections
5858
- :ref:`Export <compass-export-connections-cli>` favorite connections.
5959

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-
6560
* - .. option:: --help
6661
- Show |compass| options.
6762

@@ -75,6 +70,18 @@ configuration file.
7570
Specify a passphrase to decrypt the :ref:`imported favorite
7671
connections <compass-import-connections-cli-encrypted>` file.
7772

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+
7885
* - .. option:: --version
7986
- Show |compass| version.
8087

@@ -96,6 +103,10 @@ value in the :guilabel:`Settings` panel.
96103
- Enable :ref:`automatic updates <enable-automatic-updates>`. Use
97104
``--no-autoUpdates`` to disable automatic updates.
98105

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+
99110
* - .. option:: --enableFeedbackPanel
100111
- Enable the feedback panel. Use ``--no-enableFeedbackPanel`` to disable
101112
automatic updates.
@@ -114,11 +125,19 @@ value in the :guilabel:`Settings` panel.
114125

115126
To learn more, see :ref:`disable-shell`.
116127

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+
117133
* - .. option:: --forceConnectionOptions
118134
- .. include:: /includes/fact-force-connection-options.rst
119135

120136
To learn more, see :ref:`compass-force-connection-options`.
121137

138+
* - .. option:: --ignoreAdditionalCommandLineFlags
139+
- Allows additional command line flags.
140+
122141
* - .. option:: --installURLHandlers
123142
- Register |compass-short| as a handler for mongodb:// and mongodb+srv://
124143
URLs.
@@ -138,23 +157,54 @@ value in the :guilabel:`Settings` panel.
138157

139158
To learn more, see :ref:`compass-configure-network-traffic`.
140159

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+
141171
* - .. option:: --protectConnectionStrings
142172
- .. include:: /includes/fact-protect-connection-strings.rst
143173

144174
To learn more, see :ref:`compass-protect-connection-strings`.
145175

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+
146186
* - .. option:: --readOnly
147187
- Prevent users from performing write operations to your MongoDB deployment
148188
through |compass-short|.
149189

150190
To learn more, see :ref:`compass-read-only`.
151191

192+
* - .. option:: --showInsights
193+
- Enables performance insights for your schemas and queries.
194+
195+
To learn more, see :ref:`compass-performance-insights`.
196+
152197
* - .. option:: --showKerberosPasswordField
153198
- Show or hide the Kerberos password field on the |compass-short|
154199
connection form.
155200

156201
To learn more, see :ref:`compass-kerberos-password`.
157202

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+
158208
* - .. option:: --theme
159209
- Specify the |compass| UI theme. The supported themes are ``DARK``,
160210
``LIGHT``, and ``OS_THEME``.
@@ -163,6 +213,12 @@ value in the :guilabel:`Settings` panel.
163213
- Enable sending usage statistics. Use ``--no-trackUsageStatistics``
164214
to disable sending usage statistics.
165215

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+
166222
.. include:: /includes/fact-configuration-options-executable.rst
167223

168224
Learn More

0 commit comments

Comments
 (0)