Skip to content

Commit fb20c84

Browse files
authored
Add installation instructions to Learn section (#8752)
1 parent 5ab89f7 commit fb20c84

File tree

3 files changed

+71
-37
lines changed

3 files changed

+71
-37
lines changed

docs/intro/index.rst

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,14 @@
11
.. _ref_intro:
22

3-
Get Started
4-
===========
3+
==============
4+
Welcome to Gel
5+
==============
56

67
.. toctree::
78
:maxdepth: 3
89
:hidden:
910

11+
installation
1012
quickstart/index
1113
tutorials/index
1214
guides/index

docs/intro/installation.rst

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
.. _ref_cli_gel_install:
2+
3+
============
4+
Installation
5+
============
6+
7+
We provide a :ref:`CLI for managing and interacting with local and remote databases <ref_cli_overview>`. If you're using JavaScript or Python, our client libraries will handle downloading and running the CLI for you using tools like ``npx`` and ``uvx``.
8+
9+
For everyone else, or if you wish to install the CLI globally, you can install using our bash installer or your operating system's package manager.
10+
11+
.. tabs::
12+
13+
.. code-tab:: bash
14+
:caption: bash
15+
16+
$ curl https://www.geldata.com/sh --proto "=https" -sSf1 | sh
17+
18+
.. code-tab:: powershell
19+
:caption: Powershell
20+
21+
PS> irm https://www.geldata.com/ps1 | iex
22+
23+
.. code-tab:: bash
24+
:caption: Homebrew
25+
26+
$ brew install geldata/tap/gel-cli
27+
28+
.. code-tab:: bash
29+
:caption: Nixpkgs
30+
31+
$ nix-shell -p gel
32+
33+
.. code-tab:: bash
34+
:caption: JavaScript
35+
36+
$ npx gel --version
37+
38+
.. code-tab:: bash
39+
:caption: Python
40+
41+
$ uvx gel --version

docs/reference/using/cli/index.rst

Lines changed: 26 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -6,39 +6,43 @@ CLI
66

77
:edb-alt-title: The Gel CLI
88

9-
The |gelcmd| command-line interface (CLI) provides an idiomatic way to
10-
install |Gel|, spin up local instances, open a REPL, execute queries,
11-
manage auth roles, introspect schema, create migrations, and more.
9+
The |gelcmd| command-line interface (CLI) provides an idiomatic way to spin up local instances, open a REPL, execute queries, manage auth roles, introspect schema, create migrations, and more.
1210

13-
You can install it with one shell command.
11+
If you're using JavaScript or Python, our client libraries will handle downloading and running the CLI for you using tools like ``npx`` and ``uvx``.
1412

15-
.. _ref_cli_gel_install:
13+
For everyone else, or if you wish to install the CLI globally, you can install using our bash installer or your operating system's package manager.
1614

17-
.. rubric:: Installation
15+
.. tabs::
1816

19-
On Linux or MacOS, run the following in your terminal and follow the
20-
on-screen instructions:
17+
.. code-tab:: bash
18+
:caption: bash
2119

22-
.. code-block:: bash
20+
$ curl https://www.geldata.com/sh --proto "=https" -sSf1 | sh
21+
22+
.. code-tab:: powershell
23+
:caption: Powershell
24+
25+
PS> irm https://www.geldata.com/ps1 | iex
2326

24-
$ curl --proto '=https' --tlsv1.2 -sSf https://www.geldata.com/sh | sh
27+
.. code-tab:: bash
28+
:caption: Homebrew
2529

26-
For Windows, the installation script is:
30+
$ brew install geldata/tap/gel-cli
2731

28-
.. code-block:: powershell
32+
.. code-tab:: bash
33+
:caption: Nixpkgs
2934

30-
PS> iwr https://www.geldata.com/ps1 -useb | iex
35+
$ nix-shell -p gel
3136

32-
* The `script <https://www.geldata.com/sh>`_, inspired by ``rustup``, will
33-
detect the OS and download the appropriate build of the Gel CLI
34-
tool, ``gel``.
35-
* The |gelcmd| command is a single executable (it's `open source!
36-
<https://github.com/geldata/gel-cli/>`_)
37-
* Once installed, the ``gel`` command can be used to install,
38-
uninstall, upgrade, and interact with |Gel| server instances.
39-
* You can uninstall Gel server or remove the ``gel`` command at
40-
any time.
37+
.. code-tab:: bash
38+
:caption: JavaScript
4139

40+
$ npx gel --version
41+
42+
.. code-tab:: bash
43+
:caption: Python
44+
45+
$ uvx gel --version
4246

4347
.. rubric:: Connection options
4448

@@ -48,19 +52,6 @@ a target instance. This instance can be local to your machine or hosted
4852
remotely.
4953

5054

51-
.. _ref_cli_gel_nightly:
52-
53-
.. rubric:: Nightly version
54-
55-
To install the nightly version of the CLI (not to be confused with the nightly
56-
version of |Gel| itself!) use this command:
57-
58-
.. code-block:: bash
59-
60-
$ curl --proto '=https' --tlsv1.2 -sSf https://www.geldata.com/sh | \
61-
sh -s -- --nightly
62-
63-
6455
.. _ref_cli_gel_uninstall:
6556

6657
.. rubric:: Uninstallation

0 commit comments

Comments
 (0)