Skip to content

Commit f8ed88d

Browse files
authored
DOCSP-27031 Compass CLI options (#445)
* DOCSP-27031 documents CLI options * internal review feedback * internal review feedback * external review feedback * external review feedback * external review feedback * removes --lgDarkmode
1 parent 2eb824d commit f8ed88d

File tree

3 files changed

+88
-9
lines changed

3 files changed

+88
-9
lines changed

source/command-line-options.txt

Lines changed: 84 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
.. _cli-options:
22

3+
.. program:: compass
4+
35
----------------------------
46
Compass Command Line Options
57
----------------------------
@@ -33,18 +35,91 @@ Use the following syntax to start |compass| and set a configuration option:
3335
Options
3436
-------
3537

36-
You can set the following configuration options using the command line:
38+
You can set these options when using the command line.
39+
40+
Command Line Only
41+
~~~~~~~~~~~~~~~~~
42+
43+
These options can only be set on the command line. These options
44+
cannot be set in the :guilabel:`Settings` panel.
45+
46+
.. option:: --exportConnections
47+
48+
:ref:`Export <compass-export-connections-cli>` favorite connections.
49+
50+
.. option:: --file <file>
51+
52+
Specify a file containing a :ref:`list of connections
53+
<compass-export-connections-cli>`. These connections are
54+
automatically available once |compass| starts.
55+
56+
.. option:: --help
57+
58+
Show |compass| options.
59+
60+
.. option:: --importConnections
61+
62+
:ref:`Import <compass-import-connections-cli>` favorite connections.
63+
64+
.. option:: --passphrase
65+
66+
Specify a passphrase to encrypt the :ref:`exported favorite
67+
connections <compass-export-connections-cli-encrypted>` output file.
68+
69+
Specify a passphrase to decrypt the :ref:`imported favorite
70+
connections <compass-import-connections-cli-encrypted>` file.
71+
72+
.. option:: --version
73+
74+
Show |compass| version.
75+
76+
Command Line or Settings Panel
77+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
78+
79+
These options can be set on the command line **or** in the
80+
:guilabel:`Settings` panel. Setting an option on the command line
81+
overrides the value in the :guilabel:`Settings` panel.
82+
83+
.. option:: --autoUpdates
84+
85+
Enable :ref:`automatic updates <enable-automatic-updates>`. Use
86+
``--no-autoUpdates`` to disable automatic updates.
87+
88+
.. option:: --enableFeedbackPanel
89+
90+
Enable the feedback panel. Use ``--no-enableFeedbackPanel`` to
91+
disable automatic updates.
92+
93+
.. option:: --enableMaps
94+
95+
Allow |compass| to make requests to a 3rd party mapping service. Use
96+
``--no-enableMaps`` to disable mapping requests.
97+
98+
.. option:: --networkTraffic
99+
100+
Configure |compass| to only allow outgoing :ref:`network operations
101+
<compass-configure-network-traffic>` to connect to the database.
102+
103+
.. option:: --protectConnectionStrings
104+
105+
Hide credentials in connection strings. Passwords in connection
106+
strings are displayed as `*****`.
107+
108+
.. option:: --theme
109+
110+
Specify the |compass| UI theme. The supported themes are ``DARK``,
111+
``LIGHT``, and ``OS_THEME``.
112+
113+
.. option:: --trackErrors
37114

38-
.. list-table::
39-
:header-rows: 1
40-
:widths: 15 60
115+
Enable sending crash reports. Use ``--no-trackErrors`` to disable
116+
sending crash reports.
117+
118+
.. option:: --trackUsageStatistics
41119

42-
* - Option
43-
- Definition
120+
Enable sending usage statistics. Use ``--no-trackUsageStatistics``
121+
to disable sending usage statistics.
44122

45-
* - :ref:`networkTraffic <compass-configure-network-traffic>`
46-
- Configure |compass| to not perform outgoing network operations other
47-
than those to the database.
48123

49124
Learn More
50125
----------

source/connect/favorite-connections/import-export-cli/import.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,8 @@ Prerequisite
2222
To import favorite connections, you must first :ref:`export the
2323
connections <compass-export-connections-cli>`.
2424

25+
.. _compass-import-connections-cli-encrypted:
26+
2527
Import Encrypted Favorite Connections
2628
-------------------------------------
2729

source/upgrade.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,8 @@ versions of Compass to upgrade.
3434
your system settings to grant |compass-short| permission to run. For
3535
more information, see :ref:`compass-install`.
3636

37+
.. _enable-automatic-updates:
38+
3739
Enable Automatic Updates
3840
------------------------
3941

0 commit comments

Comments
 (0)