11.. program:: compass
22.. _cli-options:
33
4- ----------------------------
5- Compass Command Line Options
6- ----------------------------
4+ --------------------
5+ Command Line Options
6+ --------------------
77
88.. default-domain:: mongodb
99
@@ -13,9 +13,7 @@ Compass Command Line Options
1313 :depth: 1
1414 :class: singlecol
1515
16- The following page provides an overview on how to set command line options for
17- |compass|. For more detailed guidance on how to set a specific command line
18- option, see the task page for the specific option.
16+ You can customize |compass| using command line options.
1917
2018Definition
2119----------
@@ -42,43 +40,43 @@ Use the following syntax to start |compass| and set a configuration option:
4240Options
4341-------
4442
45- You can set these options when using the command line.
46-
4743Command Line Only
4844~~~~~~~~~~~~~~~~~
4945
5046These options can only be set on the command line. These options
51- cannot be set in the :guilabel:`Settings` panel.
47+ cannot be set in the :guilabel:`Settings` panel or the |compass-short|
48+ configuration file.
5249
53- .. option:: --exportConnections
54-
55- :ref:`Export <compass-export-connections-cli>` favorite connections.
50+ .. list-table::
51+ :header-rows: 1
52+ :widths: 40 60
5653
57- .. option:: --file <file>
58-
59- Specify a file containing a :ref:`list of connections
60- <compass-export-connections-cli>`. These connections are
61- automatically available once |compass| starts.
54+ * - Setting
55+ - Definition
6256
63- .. option:: --help
64-
65- Show |compass| options.
57+ * - .. option:: --exportConnections
58+ - :ref:`Export <compass-export-connections-cli>` favorite connections.
6659
67- .. option:: --importConnections
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.
6864
69- :ref:`Import <compass-import-connections-cli>` favorite connections.
65+ * - .. option:: --help
66+ - Show |compass| options.
7067
71- .. option:: --passphrase
72-
73- Specify a passphrase to encrypt the :ref:`exported favorite
74- connections <compass-export-connections-cli-encrypted>` output file.
68+ * - .. option:: --importConnections
69+ - :ref:`Import <compass-import-connections-cli>` favorite connections.
7570
76- Specify a passphrase to decrypt the :ref:`imported favorite
77- connections <compass-import-connections-cli-encrypted>` file.
71+ * - .. option:: --passphrase
72+ - Specify a passphrase to encrypt the :ref:`exported favorite connections
73+ <compass-export-connections-cli-encrypted>` output file.
7874
79- .. option:: --version
75+ Specify a passphrase to decrypt the :ref:`imported favorite
76+ connections <compass-import-connections-cli-encrypted>` file.
8077
81- Show |compass| version.
78+ * - .. option:: --version
79+ - Show |compass| version.
8280
8381General Settings
8482~~~~~~~~~~~~~~~~
@@ -87,50 +85,85 @@ These options can be set on the command line, in a configuration file, or in the
8785:guilabel:`Settings` panel. Setting an option on the command line overrides the
8886value in the :guilabel:`Settings` panel.
8987
90- .. option:: --autoUpdates
91-
92- Enable :ref:`automatic updates <enable-automatic-updates>`. Use
93- ``--no-autoUpdates`` to disable automatic updates.
88+ .. list-table::
89+ :header-rows: 1
90+ :widths: 40 60
91+
92+ * - Setting
93+ - Definition
9494
95- .. option:: --enableFeedbackPanel
96-
97- Enable the feedback panel. Use ``--no-enableFeedbackPanel`` to
98- disable automatic updates.
95+ * - .. option:: --autoUpdates
96+ - Enable :ref:`automatic updates <enable-automatic-updates>`. Use
97+ ``--no-autoUpdates`` to disable automatic updates.
9998
100- .. option:: --enableMaps
101-
102- Allow |compass| to make requests to a 3rd party mapping service. Use
103- ``--no-enableMaps`` to disable mapping requests.
99+ * - .. option:: --enableFeedbackPanel
100+ - Enable the feedback panel. Use ``--no-enableFeedbackPanel`` to disable
101+ automatic updates.
102+
103+ * - .. option:: --enableDevTools
104+ - Enable Chrome DevTools in |compass-short|.
105+
106+ To learn more, see :ref:`compass-enable-dev-tools`.
104107
105- .. option:: --forceConnectionOptions
108+ * - .. option:: --enableMaps
109+ - Allow |compass| to make requests to a 3rd party mapping service. Use
110+ ``--no-enableMaps`` to disable mapping requests.
106111
107- .. include:: /includes/fact-force-connection-options.rst
108-
109- To learn more, see :ref:`compass-force-connection-options`.
112+ * - .. option:: --enableShell
113+ - Enable or disable the embedded MongoDB Shell on |compass-short|.
110114
111- .. option:: --networkTraffic
115+ To learn more, see :ref:`disable-shell`.
112116
113- Configure |compass| to only allow outgoing :ref:`network operations
114- <compass-configure-network-traffic>` to connect to the database.
117+ * - .. option:: --forceConnectionOptions
118+ - .. include:: /includes/fact-force-connection-options.rst
119+
120+ To learn more, see :ref:`compass-force-connection-options`.
115121
116- To learn more, see :ref:`compass-configure-network-traffic`.
122+ * - .. option:: --installURLHandlers
123+ - Register |compass-short| as a handler for mongodb:// and mongodb+srv://
124+ URLs.
117125
118- .. option:: --protectConnectionStrings
126+ If :guilabel:`Install Compass as URL Protocol Handler` is enabled,
127+ you can open |compass-short| by navigating to a mongodb:// or
128+ mongodb+srv:// URL in your internet browser.
119129
120- .. include:: /includes/fact-protect-connection-strings.rst
121-
122- To learn more, see :ref:`compass-protect-connection-strings`.
130+ *Available on macOS and Windows.*
131+
132+ * - .. option:: --maxTimeMS
133+ - Specify an upper time limit for all |compass-short| database operations.
123134
124- .. option:: --theme
135+ * - .. option:: --networkTraffic
136+ - Configure |compass| to only allow outgoing :ref:`network operations
137+ <compass-configure-network-traffic>` to connect to the database.
125138
126- Specify the |compass| UI theme. The supported themes are ``DARK``,
127- ``LIGHT``, and ``OS_THEME``.
139+ To learn more, see :ref:`compass-configure-network-traffic`.
140+
141+ * - .. option:: --protectConnectionStrings
142+ - .. include:: /includes/fact-protect-connection-strings.rst
128143
129- .. option:: --trackUsageStatistics
144+ To learn more, see :ref:`compass-protect-connection-strings`.
145+
146+ * - .. option:: --readOnly
147+ - Prevent users from performing write operations to your MongoDB deployment
148+ through |compass-short|.
149+
150+ To learn more, see :ref:`compass-read-only`.
130151
131- Enable sending usage statistics. Use ``--no-trackUsageStatistics``
132- to disable sending usage statistics.
152+ * - .. option:: --showKerberosPasswordField
153+ - Show or hide the Kerberos password field on the |compass-short|
154+ connection form.
155+
156+ To learn more, see :ref:`compass-kerberos-password`.
157+
158+ * - .. option:: --theme
159+ - Specify the |compass| UI theme. The supported themes are ``DARK``,
160+ ``LIGHT``, and ``OS_THEME``.
161+
162+ * - .. option:: --trackUsageStatistics
163+ - Enable sending usage statistics. Use ``--no-trackUsageStatistics``
164+ to disable sending usage statistics.
133165
166+ .. include:: /includes/fact-configuration-options-executable.rst
134167
135168Learn More
136169----------
0 commit comments