You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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
Copy file name to clipboardExpand all lines: docs/reference/using/cli/index.rst
+26-35Lines changed: 26 additions & 35 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,39 +6,43 @@ CLI
6
6
7
7
:edb-alt-title: The Gel CLI
8
8
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.
12
10
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``.
14
12
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.
16
14
17
-
.. rubric:: Installation
15
+
.. tabs::
18
16
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
21
19
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
23
26
24
-
$ curl --proto '=https' --tlsv1.2 -sSf https://www.geldata.com/sh | sh
27
+
.. code-tab:: bash
28
+
:caption: Homebrew
25
29
26
-
For Windows, the installation script is:
30
+
$ brew install geldata/tap/gel-cli
27
31
28
-
.. code-block:: powershell
32
+
.. code-tab:: bash
33
+
:caption: Nixpkgs
29
34
30
-
PS> iwr https://www.geldata.com/ps1 -useb | iex
35
+
$ nix-shell -p gel
31
36
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
41
39
40
+
$ npx gel --version
41
+
42
+
.. code-tab:: bash
43
+
:caption: Python
44
+
45
+
$ uvx gel --version
42
46
43
47
.. rubric:: Connection options
44
48
@@ -48,19 +52,6 @@ a target instance. This instance can be local to your machine or hosted
48
52
remotely.
49
53
50
54
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
0 commit comments