Skip to content

Commit b7fcc8a

Browse files
authored
Add reference docs for extension command group (#8577)
Also remove vestigial `-E` option in extension guide.
1 parent 8215a7d commit b7fcc8a

File tree

7 files changed

+156
-3
lines changed

7 files changed

+156
-3
lines changed

docs/reference/datamodel/extensions.rst

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -53,8 +53,7 @@ Standalone extensions
5353

5454
.. api-index:: postgis
5555

56-
Additionally, standalone extension packages can be installed via the CLI,
57-
with ``postgis`` being a notable example.
56+
Additionally, standalone extension packages can be installed on local project-managed instances via the CLI, with ``postgis`` being a notable example.
5857

5958
List installed extensions:
6059

@@ -79,7 +78,7 @@ Install the ``postgis`` extension:
7978

8079
.. code-block:: bash
8180
82-
$ gel extension install -E postgis
81+
$ gel extension install postgis
8382
Found extension package: postgis version 3.4.3+6b82d77
8483
00:00:03 [====================] 22.49 MiB/22.49 MiB
8584
Extension 'postgis' installed successfully.
Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
.. _ref_cli_gel_extension:
2+
3+
=============
4+
gel extension
5+
=============
6+
7+
The :gelcmd:`extension` command group contains commands for managing standalone extensions.
8+
9+
.. toctree::
10+
:maxdepth: 2
11+
:hidden:
12+
13+
list
14+
list-available
15+
install
16+
uninstall
17+
18+
Subcommands
19+
===========
20+
21+
.. list-table::
22+
:class: synopsis
23+
24+
* - :ref:`ref_cli_gel_extension_list`
25+
- List installed extensions.
26+
* - :ref:`ref_cli_gel_extension_list_available`
27+
- List available extensions.
28+
* - :ref:`ref_cli_gel_extension_install`
29+
- Install an extension.
30+
* - :ref:`ref_cli_gel_extension_uninstall`
31+
- Uninstall an extension.
32+
33+
See :ref:`Connection options <ref_cli_gel_connopts>` for options applicable to all subcommands.
Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
.. _ref_cli_gel_extension_install:
2+
3+
=====================
4+
gel extension install
5+
=====================
6+
7+
Install an extension.
8+
9+
.. cli:synopsis::
10+
11+
gel extension install <extension> [<options>]
12+
13+
Arguments
14+
=========
15+
16+
:cli:synopsis:`<extension>`
17+
The name of the extension to install.
18+
19+
Options
20+
=======
21+
22+
See :ref:`Connection options <ref_cli_gel_connopts>` for global options.
23+
24+
Examples
25+
========
26+
27+
Install the ``postgis`` extension:
28+
29+
.. code-block:: bash
30+
31+
$ gel extension install postgis
32+
Found extension package: postgis version 3.4.3+6b82d77
33+
00:00:03 [====================] 22.49 MiB/22.49 MiB
34+
Extension 'postgis' installed successfully.
Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
.. _ref_cli_gel_extension_list_available:
2+
3+
============================
4+
gel extension list-available
5+
============================
6+
7+
List available extensions.
8+
9+
.. cli:synopsis::
10+
11+
gel extension list-available [<options>]
12+
13+
Options
14+
=======
15+
16+
See :ref:`Connection options <ref_cli_gel_connopts>` for global options.
17+
18+
Examples
19+
========
20+
21+
.. code-block:: bash
22+
23+
$ gel extension list-available
24+
┌─────────┬───────────────┐
25+
│ Name │ Version │
26+
│ postgis │ 3.4.3+6b82d77 │
27+
└─────────┴───────────────┘
Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
.. _ref_cli_gel_extension_list:
2+
3+
==================
4+
gel extension list
5+
==================
6+
7+
List installed extensions.
8+
9+
.. cli:synopsis::
10+
11+
gel extension list [<options>]
12+
13+
Options
14+
=======
15+
16+
See :ref:`Connection options <ref_cli_gel_connopts>` for global options.
17+
18+
Examples
19+
========
20+
21+
.. code-block:: bash
22+
23+
$ gel extension list
24+
┌─────────┬───────────────┐
25+
│ Name │ Version │
26+
│ postgis │ 3.4.3+6b82d77 │
27+
└─────────┴───────────────┘
Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
.. _ref_cli_gel_extension_uninstall:
2+
3+
=======================
4+
gel extension uninstall
5+
=======================
6+
7+
Uninstall an extension.
8+
9+
.. cli:synopsis::
10+
11+
gel extension uninstall <extension> [<options>]
12+
13+
Arguments
14+
=========
15+
16+
:cli:synopsis:`<extension>`
17+
The name of the extension to uninstall.
18+
19+
Options
20+
=======
21+
22+
See :ref:`Connection options <ref_cli_gel_connopts>` for global options.
23+
24+
Examples
25+
========
26+
27+
Uninstall the ``postgis`` extension:
28+
29+
.. code-block:: bash
30+
31+
$ gel extension uninstall postgis
32+
Extension 'postgis' uninstalled successfully.

docs/reference/using/cli/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -151,6 +151,7 @@ The ``cli.toml`` has the following structure. All fields are optional:
151151
gel_list
152152
gel_info
153153
gel_cli_upgrade
154+
gel_extension/index
154155
gel_server/index
155156
gel_describe/index
156157
gel_instance/index

0 commit comments

Comments
 (0)