-
Notifications
You must be signed in to change notification settings - Fork 444
Add reference docs for extension command group
#8577
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,33 @@ | ||
| .. _ref_cli_gel_extension: | ||
|
|
||
| ============= | ||
| gel extension | ||
| ============= | ||
|
|
||
| The :gelcmd:`extension` command group contains commands for managing standalone extensions. | ||
|
|
||
| .. toctree:: | ||
| :maxdepth: 2 | ||
| :hidden: | ||
|
|
||
| list | ||
| list-available | ||
| install | ||
| uninstall | ||
|
|
||
| Subcommands | ||
| =========== | ||
|
|
||
| .. list-table:: | ||
| :class: synopsis | ||
|
|
||
| * - :ref:`ref_cli_gel_extension_list` | ||
| - List installed extensions. | ||
| * - :ref:`ref_cli_gel_extension_list_available` | ||
| - List available extensions. | ||
| * - :ref:`ref_cli_gel_extension_install` | ||
| - Install an extension. | ||
| * - :ref:`ref_cli_gel_extension_uninstall` | ||
| - Uninstall an extension. | ||
|
|
||
| See :ref:`Connection options <ref_cli_gel_connopts>` for options applicable to all subcommands. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,34 @@ | ||
| .. _ref_cli_gel_extension_install: | ||
|
|
||
| ===================== | ||
| gel extension install | ||
| ===================== | ||
|
|
||
| Install an extension. | ||
|
|
||
| .. cli:synopsis:: | ||
| gel extension install <extension> [<options>] | ||
|
|
||
| Arguments | ||
| ========= | ||
|
|
||
| :cli:synopsis:`<extension>` | ||
| The name of the extension to install. | ||
|
|
||
| Options | ||
| ======= | ||
|
|
||
| See :ref:`Connection options <ref_cli_gel_connopts>` for global options. | ||
|
|
||
| Examples | ||
| ======== | ||
|
|
||
| Install the ``postgis`` extension: | ||
|
|
||
| .. code-block:: bash | ||
| $ gel extension install postgis | ||
| Found extension package: postgis version 3.4.3+6b82d77 | ||
| 00:00:03 [====================] 22.49 MiB/22.49 MiB | ||
| Extension 'postgis' installed successfully. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| .. _ref_cli_gel_extension_list_available: | ||
|
|
||
| ============================ | ||
| gel extension list-available | ||
| ============================ | ||
|
|
||
| List available extensions. | ||
|
|
||
| .. cli:synopsis:: | ||
|
|
||
| gel extension list-available [<options>] | ||
|
|
||
| Options | ||
| ======= | ||
|
|
||
| See :ref:`Connection options <ref_cli_gel_connopts>` for global options. | ||
|
|
||
| Examples | ||
| ======== | ||
|
|
||
| .. code-block:: bash | ||
|
|
||
| $ gel extension list-available | ||
| ┌─────────┬───────────────┐ | ||
| │ Name │ Version │ | ||
| │ postgis │ 3.4.3+6b82d77 │ | ||
| └─────────┴───────────────┘ | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| .. _ref_cli_gel_extension_list: | ||
|
|
||
| ================== | ||
| gel extension list | ||
| ================== | ||
|
|
||
| List installed extensions. | ||
|
|
||
| .. cli:synopsis:: | ||
|
|
||
| gel extension list [<options>] | ||
|
|
||
| Options | ||
| ======= | ||
|
|
||
| See :ref:`Connection options <ref_cli_gel_connopts>` for global options. | ||
|
|
||
| Examples | ||
| ======== | ||
|
|
||
| .. code-block:: bash | ||
|
|
||
| $ gel extension list | ||
| ┌─────────┬───────────────┐ | ||
| │ Name │ Version │ | ||
| │ postgis │ 3.4.3+6b82d77 │ | ||
| └─────────┴───────────────┘ |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,32 @@ | ||
| .. _ref_cli_gel_extension_uninstall: | ||
|
|
||
| ======================= | ||
| gel extension uninstall | ||
| ======================= | ||
|
|
||
| Uninstall an extension. | ||
|
|
||
| .. cli:synopsis:: | ||
| gel extension uninstall <extension> [<options>] | ||
|
|
||
| Arguments | ||
| ========= | ||
|
|
||
| :cli:synopsis:`<extension>` | ||
| The name of the extension to uninstall. | ||
|
|
||
| Options | ||
| ======= | ||
|
|
||
| See :ref:`Connection options <ref_cli_gel_connopts>` for global options. | ||
|
|
||
| Examples | ||
| ======== | ||
|
|
||
| Uninstall the ``postgis`` extension: | ||
|
|
||
| .. code-block:: bash | ||
| $ gel extension uninstall postgis | ||
| Extension 'postgis' uninstalled successfully. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Unrelated and nitpick, but is there a plan for a shortcut for this?
list-availableis long to type 😅There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Eh, hopefully this something you need to do often enough for it to be annoying 😅 Maybe one day we can have an alias feature like git.