Skip to content

Commit e402a47

Browse files
sarahsimpersCopybara
sarahsimpers
and
Copybara
authored
Project import generated by Copybara. (#575)
GitOrigin-RevId: 64516d5ec8a7fe7934dfbd28d454aaba3fe6dd86 Co-authored-by: Copybara <[email protected]>
1 parent eeab32e commit e402a47

8 files changed

+412
-2
lines changed

‎source/command/atlas-deployments-connect.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ Options
5454
* - --connectWith
5555
- string
5656
- false
57-
- Method for connecting to the deployment. Valid values are mongosh, compass, and skip.
57+
- Method for connecting to the deployment. Valid values are compass, connectionString and mongosh.
5858
* - --connectionStringType
5959
- string
6060
- false

‎source/command/atlas-deployments-setup.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ Options
6464
* - --connectWith
6565
- string
6666
- false
67-
- Method for connecting to the deployment. Valid values are mongosh, compass, and skip.
67+
- Method for connecting to the deployment. Valid values are compass, mongosh and skip.
6868
* - --currentIp
6969
-
7070
- false

‎source/command/atlas-plugin-install.txt

Lines changed: 99 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,99 @@
1+
.. _atlas-plugin-install:
2+
3+
====================
4+
atlas plugin install
5+
====================
6+
7+
.. default-domain:: mongodb
8+
9+
.. contents:: On this page
10+
:local:
11+
:backlinks: none
12+
:depth: 1
13+
:class: singlecol
14+
15+
Install Atlas CLI plugin from a GitHub repository.
16+
17+
Install an Atlas CLI plugin from a GitHub repository.
18+
You can specify a GitHub repository using either the "<github-owner>/<github-repository-name>" format or a full URL.
19+
When you install the plugin, its latest release on GitHub is used by default.
20+
To install a specific version of the plugin, append the version number directly to the plugin name using the @ symbol.
21+
22+
MongoDB provides an example plugin: https://github.com/mongodb/atlas-cli-plugin-example
23+
24+
25+
Syntax
26+
------
27+
28+
.. code-block::
29+
:caption: Command Syntax
30+
31+
atlas plugin install [<github-owner>/<github-repository-name>] [options]
32+
33+
.. Code end marker, please don't delete this comment
34+
35+
Arguments
36+
---------
37+
38+
.. list-table::
39+
:header-rows: 1
40+
:widths: 20 10 10 60
41+
42+
* - Name
43+
- Type
44+
- Required
45+
- Description
46+
* - <github-owner>/<github-repository-name>
47+
- string
48+
- false
49+
- Repository identifier.
50+
51+
Options
52+
-------
53+
54+
.. list-table::
55+
:header-rows: 1
56+
:widths: 20 10 10 60
57+
58+
* - Name
59+
- Type
60+
- Required
61+
- Description
62+
* - -h, --help
63+
-
64+
- false
65+
- help for install
66+
67+
Inherited Options
68+
-----------------
69+
70+
.. list-table::
71+
:header-rows: 1
72+
:widths: 20 10 10 60
73+
74+
* - Name
75+
- Type
76+
- Required
77+
- Description
78+
* - -P, --profile
79+
- string
80+
- false
81+
- Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings.
82+
83+
Examples
84+
--------
85+
86+
.. code-block::
87+
:copyable: false
88+
89+
# Install the latest version of the plugin:
90+
atlas plugin install mongodb/atlas-cli-plugin-example
91+
atlas plugin install https://github.com/mongodb/atlas-cli-plugin-example
92+
93+
94+
.. code-block::
95+
:copyable: false
96+
97+
# Install a specific version of the plugin:
98+
atlas plugin install mongodb/[email protected]
99+
atlas plugin install https://github.com/mongodb/atlas-cli-plugin-example/@v1.2.3

‎source/command/atlas-plugin-list.txt

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
.. _atlas-plugin-list:
2+
3+
=================
4+
atlas plugin list
5+
=================
6+
7+
.. default-domain:: mongodb
8+
9+
.. contents:: On this page
10+
:local:
11+
:backlinks: none
12+
:depth: 1
13+
:class: singlecol
14+
15+
Returns a list of all installed plugins.
16+
17+
Syntax
18+
------
19+
20+
.. code-block::
21+
:caption: Command Syntax
22+
23+
atlas plugin list [options]
24+
25+
.. Code end marker, please don't delete this comment
26+
27+
Options
28+
-------
29+
30+
.. list-table::
31+
:header-rows: 1
32+
:widths: 20 10 10 60
33+
34+
* - Name
35+
- Type
36+
- Required
37+
- Description
38+
* - -h, --help
39+
-
40+
- false
41+
- help for list
42+
43+
Inherited Options
44+
-----------------
45+
46+
.. list-table::
47+
:header-rows: 1
48+
:widths: 20 10 10 60
49+
50+
* - Name
51+
- Type
52+
- Required
53+
- Description
54+
* - -P, --profile
55+
- string
56+
- false
57+
- Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings.
58+

‎source/command/atlas-plugin-uninstall.txt

Lines changed: 87 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
.. _atlas-plugin-uninstall:
2+
3+
======================
4+
atlas plugin uninstall
5+
======================
6+
7+
.. default-domain:: mongodb
8+
9+
.. contents:: On this page
10+
:local:
11+
:backlinks: none
12+
:depth: 1
13+
:class: singlecol
14+
15+
Uninstall Atlas CLI plugin.
16+
17+
Uninstall an Atlas CLI plugin.
18+
You can specify a plugin to uninstall using either the "<github-owner>/<github-repository-name>" format or the plugin name.
19+
20+
21+
Syntax
22+
------
23+
24+
.. code-block::
25+
:caption: Command Syntax
26+
27+
atlas plugin uninstall [plugin] [options]
28+
29+
.. Code end marker, please don't delete this comment
30+
31+
Arguments
32+
---------
33+
34+
.. list-table::
35+
:header-rows: 1
36+
:widths: 20 10 10 60
37+
38+
* - Name
39+
- Type
40+
- Required
41+
- Description
42+
* - plugin
43+
- string
44+
- false
45+
- Plugin identifier.
46+
47+
Options
48+
-------
49+
50+
.. list-table::
51+
:header-rows: 1
52+
:widths: 20 10 10 60
53+
54+
* - Name
55+
- Type
56+
- Required
57+
- Description
58+
* - -h, --help
59+
-
60+
- false
61+
- help for uninstall
62+
63+
Inherited Options
64+
-----------------
65+
66+
.. list-table::
67+
:header-rows: 1
68+
:widths: 20 10 10 60
69+
70+
* - Name
71+
- Type
72+
- Required
73+
- Description
74+
* - -P, --profile
75+
- string
76+
- false
77+
- Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings.
78+
79+
Examples
80+
--------
81+
82+
.. code-block::
83+
:copyable: false
84+
85+
# Uninstall a plugin:
86+
atlas plugin uninstall mongodb/atlas-cli-plugin-example
87+
atlas plugin uninstall atlas-cli-plugin-example

‎source/command/atlas-plugin-update.txt

Lines changed: 99 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,99 @@
1+
.. _atlas-plugin-update:
2+
3+
===================
4+
atlas plugin update
5+
===================
6+
7+
.. default-domain:: mongodb
8+
9+
.. contents:: On this page
10+
:local:
11+
:backlinks: none
12+
:depth: 1
13+
:class: singlecol
14+
15+
Update Atlas CLI plugin.
16+
17+
Update an Atlas CLI plugin.
18+
You can specify a plugin to update using either the "<github-owner>/<github-repository-name>" format or the plugin name.
19+
Additionally, you can use the "--all" flag to update all plugins.
20+
21+
22+
Syntax
23+
------
24+
25+
.. code-block::
26+
:caption: Command Syntax
27+
28+
atlas plugin update [plugin] [options]
29+
30+
.. Code end marker, please don't delete this comment
31+
32+
Arguments
33+
---------
34+
35+
.. list-table::
36+
:header-rows: 1
37+
:widths: 20 10 10 60
38+
39+
* - Name
40+
- Type
41+
- Required
42+
- Description
43+
* - plugin
44+
- string
45+
- false
46+
- Plugin identifier.
47+
48+
Options
49+
-------
50+
51+
.. list-table::
52+
:header-rows: 1
53+
:widths: 20 10 10 60
54+
55+
* - Name
56+
- Type
57+
- Required
58+
- Description
59+
* - --all
60+
-
61+
- false
62+
- update all plugins
63+
* - -h, --help
64+
-
65+
- false
66+
- help for update
67+
68+
Inherited Options
69+
-----------------
70+
71+
.. list-table::
72+
:header-rows: 1
73+
:widths: 20 10 10 60
74+
75+
* - Name
76+
- Type
77+
- Required
78+
- Description
79+
* - -P, --profile
80+
- string
81+
- false
82+
- Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings.
83+
84+
Examples
85+
--------
86+
87+
.. code-block::
88+
:copyable: false
89+
90+
# Update a plugin:
91+
atlas plugin update mongodb/atlas-cli-plugin-example
92+
atlas plugin update atlas-cli-plugin-example
93+
94+
95+
.. code-block::
96+
:copyable: false
97+
98+
# Update all plugins
99+
atlas plugin update --all

0 commit comments

Comments
 (0)