Skip to content

Commit 4493b0e

Browse files
DOCSP-25363 Compass command line options (#436)
* DOCSP-25363 cli options * DOCSP-25363 cli options * DOCSP-25363 fixed ref * DOCSP-25363 internal feedback * DOCSP-25363 updates from Joe and Dave meeting * DOCSP-25363 rebase updates * DOCSP-25363 rebase updates * DOCSP-25363 fixing rebase issues * DOCSP-25363 fixing rebase issues * DOCSP-25363 fixing rebase issues * DOCSP-25363 fixed toc * DOCSP-25363 fixed toc * DOCSP-25363 added ref to Dave's page * DOCSP-25363 updated executable
1 parent 620fb8f commit 4493b0e

File tree

5 files changed

+32
-22
lines changed

5 files changed

+32
-22
lines changed

snooty.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ toc_landing_pages = [
1414
"/connect/favorite-connections/import-export-cli/",
1515
"/instance",
1616
"/config-file",
17+
"/command-line-options",
1718
"/query/filter",
1819
"/query/queries",
1920
"/documents",

source/connect/cli-options.txt renamed to source/command-line-options.txt

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,11 @@ When you use the command line to set configuration options, the options are
1616
set at startup. Settings configured using command line options cannot be
1717
modified on the |compass-short| interface.
1818

19+
Compass Executable Location
20+
---------------------------
21+
22+
.. include:: /includes/compass-executable.rst
23+
1924
Syntax
2025
------
2126

@@ -44,4 +49,6 @@ You can set the following configuration options using the command line:
4449
Learn More
4550
----------
4651

52+
- :ref:`<comp-command-line-connect>`
53+
4754
- :ref:`<config-file>`

source/connect/connect-from-the-command-line.txt

Lines changed: 1 addition & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -30,28 +30,7 @@ the command line.
3030
Compass Executable Location
3131
---------------------------
3232

33-
The name and location of the |compass-short| executable varies by
34-
operating system.
35-
36-
Linux
37-
~~~~~
38-
The executable is called ``mongodb-compass``. The installer installs it
39-
in the ``/usr/bin`` directory.
40-
41-
Windows
42-
~~~~~~~
43-
44-
The executable is called ``MongoDBCompass.exe``. The installer installs
45-
it in a folder you pick during the installation process.
46-
47-
MacOS
48-
~~~~~
49-
The executable is called ``Compass``. The installer installs
50-
it under the Applications folder:
51-
52-
.. code-block:: shell
53-
54-
/Applications/MongoDB\ Compass.app/Contents/MacOS/MongoDB\ Compass
33+
.. include:: /includes/compass-executable.rst
5534

5635
.. _compass-connect-cmd-line:
5736

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
The name and location of the |compass-short| executable varies by
2+
operating system.
3+
4+
Linux
5+
~~~~~
6+
The executable is called ``mongodb-compass``. The installer installs it
7+
in the ``/usr/bin`` directory.
8+
9+
Windows
10+
~~~~~~~
11+
12+
The executable is called ``MongoDBCompass.exe``. The installer installs
13+
it in a folder you pick during the installation process.
14+
15+
MacOS
16+
~~~~~
17+
The executable is called ``MongoDB Compass``. The installer installs
18+
it under the Applications folder:
19+
20+
.. code-block:: shell
21+
22+
/Applications/MongoDB\ Compass.app/Contents/MacOS/MongoDB\ Compass

source/index.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -155,6 +155,7 @@ Expand your knowledge of MongoDB by using Compass with other MongoDB products.
155155
/instance
156156
/manage-data
157157
/config-file
158+
/command-line-options
158159
/import-export
159160
/embedded-shell
160161
/aggregation-pipeline-builder

0 commit comments

Comments
 (0)