1
1
.. program:: compass
2
2
.. _cli-options:
3
3
4
- ----------------------------
5
- Compass Command Line Options
6
- ----------------------------
4
+ --------------------
5
+ Command Line Options
6
+ --------------------
7
7
8
8
.. default-domain:: mongodb
9
9
@@ -13,9 +13,7 @@ Compass Command Line Options
13
13
:depth: 1
14
14
:class: singlecol
15
15
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.
19
17
20
18
Definition
21
19
----------
@@ -42,43 +40,43 @@ Use the following syntax to start |compass| and set a configuration option:
42
40
Options
43
41
-------
44
42
45
- You can set these options when using the command line.
46
-
47
43
Command Line Only
48
44
~~~~~~~~~~~~~~~~~
49
45
50
46
These 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.
52
49
53
- .. option:: --exportConnections
54
-
55
- :ref:`Export <compass-export-connections-cli>` favorite connections.
50
+ .. list-table::
51
+ :header-rows: 1
52
+ :widths: 40 60
56
53
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
62
56
63
- .. option:: --help
64
-
65
- Show |compass| options.
57
+ * - .. option:: --exportConnections
58
+ - :ref:`Export <compass-export-connections-cli>` favorite connections.
66
59
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.
68
64
69
- :ref:`Import <compass-import-connections-cli>` favorite connections.
65
+ * - .. option:: --help
66
+ - Show |compass| options.
70
67
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.
75
70
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.
78
74
79
- .. option:: --version
75
+ Specify a passphrase to decrypt the :ref:`imported favorite
76
+ connections <compass-import-connections-cli-encrypted>` file.
80
77
81
- Show |compass| version.
78
+ * - .. option:: --version
79
+ - Show |compass| version.
82
80
83
81
General Settings
84
82
~~~~~~~~~~~~~~~~
@@ -87,50 +85,85 @@ These options can be set on the command line, in a configuration file, or in the
87
85
:guilabel:`Settings` panel. Setting an option on the command line overrides the
88
86
value in the :guilabel:`Settings` panel.
89
87
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
94
94
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.
99
98
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`.
104
107
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.
106
111
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|.
110
114
111
- .. option:: --networkTraffic
115
+ To learn more, see :ref:`disable-shell`.
112
116
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`.
115
121
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.
117
125
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.
119
129
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.
123
134
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.
125
138
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
128
143
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`.
130
151
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.
133
165
166
+ .. include:: /includes/fact-configuration-options-executable.rst
134
167
135
168
Learn More
136
169
----------
0 commit comments