Skip to content

Commit 0109a05

Browse files
authored
Add note about init and basic alias doc (#8755)
1 parent 3a3d7ee commit 0109a05

File tree

3 files changed

+13
-5
lines changed

3 files changed

+13
-5
lines changed

docs/intro/localdev.rst

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,7 @@ It's easy to get started with a local Gel instance. Navigate to the root of your
1818
1919
$ gel init
2020
21-
This command takes care of several things for you:
22-
23-
* It downloads and installs the latest version of the Gel server.
24-
* It configures a local Postgres cluster.
25-
* It manages the instance through your operating system's background task launcher.
21+
Creates a database tied to the current directory and to the :ref:`gel.toml <ref_reference_gel_toml>` file in it. This simplifies connection configuration and installation for you. Alias for :ref:`gel project init <ref_cli_gel_project_init>`.
2622

2723
To conserve resources, Gel automatically puts inactive local development instances to sleep. This means you can have multiple instances running without them draining your system's resources when not in use.
2824

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
.. _ref_cli_gel_init:
2+
3+
========
4+
gel init
5+
========
6+
7+
.. code-block:: bash
8+
9+
$ gel init
10+
11+
This is an alias for :ref:`gel project init <ref_cli_gel_project_init>`, and takes all of the same arguments.

docs/reference/using/cli/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -127,6 +127,7 @@ The ``cli.toml`` has the following structure. All fields are optional:
127127
gel_connopts
128128
network
129129
gel
130+
gel_init
130131
gel_project/index
131132
gel_ui
132133
gel_watch

0 commit comments

Comments
 (0)