Start using :gelcmd:

geldata · Feb 14, 2025 · 446e876 · 446e876
1 parent 696acdd
commit 446e876
Show file tree

Hide file tree

Showing 50 changed files with 65 additions and 65 deletions.
diff --git a/docs/ai/index.rst b/docs/ai/index.rst
@@ -34,7 +34,7 @@ Extension configuration
 =======================
 
 The AI extension may be configured via our UI or via EdgeQL. To use the
-built-in UI, access it by running ``gel ui``. If you have the extension
+built-in UI, access it by running :gelcmd:`ui`. If you have the extension
 enabled in your schema as shown above and have migrated that schema change, you
 will see the "AI Admin" icon in the left-hand toolbar.
 

diff --git a/docs/cli/edgedb.rst b/docs/cli/edgedb.rst
@@ -53,7 +53,7 @@ Options
     Specifies the named instance to connect to. The actual connection
     parameters are stored in ``<edgedb_config_dir>/credentials`` and are
     usually created by :ref:`ref_cli_edgedb_instance_create` or similar
-    commands. Run ``gel info`` to see the location of
+    commands. Run :gelcmd:`info` to see the location of
     ``<edgedb_config_dir>`` on your machine.
 
     This option overrides host and port.

diff --git a/docs/cli/edgedb_branch/edgedb_branch_create.rst b/docs/cli/edgedb_branch/edgedb_branch_create.rst
@@ -14,7 +14,7 @@ Create a new :ref:`branch <ref_datamodel_branches>`.
 Description
 ===========
 
-``gel branch create`` creates a new branch with the same schema as the
+:gelcmd:`branch create` creates a new branch with the same schema as the
 current branch specified in ``$CONFIG/credentials``. Without any options, it is
 equivalent to :eql:stmt:`create schema branch`.
 

diff --git a/docs/cli/edgedb_branch/edgedb_branch_wipe.rst b/docs/cli/edgedb_branch/edgedb_branch_wipe.rst
@@ -17,7 +17,7 @@ Description
 The contents of the branch will be destroyed and the schema reset to its
 state before any migrations, but the branch itself will be preserved.
 
-``gel branch wipe`` is a terminal command equivalent to
+:gelcmd:`branch wipe` is a terminal command equivalent to
 :eql:stmt:`reset schema to initial`.
 
 

diff --git a/docs/cli/edgedb_branch/index.rst b/docs/cli/edgedb_branch/index.rst
@@ -5,7 +5,7 @@
 gel branch
 ==========
 
-The ``gel branch`` group of commands contains various branch management
+The :gelcmd:`branch` group of commands contains various branch management
 tools.
 
 .. toctree::

diff --git a/docs/cli/edgedb_cli_upgrade.rst b/docs/cli/edgedb_cli_upgrade.rst
@@ -15,7 +15,7 @@ Upgrade the CLI binary.
 Description
 ===========
 
-``gel cli upgrade`` is a terminal command used to upgrade the CLI
+:gelcmd:`cli upgrade` is a terminal command used to upgrade the CLI
 tools to keep them up-to-date.
 
 

diff --git a/docs/cli/edgedb_cloud/index.rst b/docs/cli/edgedb_cloud/index.rst
@@ -29,7 +29,7 @@ offers tools to manage your instances running on our Gel Cloud.
 
 .. warning:: CI users and scripters
 
-    The ``gel cloud login`` and ``gel cloud logout`` commands are not
+    The :gelcmd:`cloud login` and :gelcmd:`cloud logout` commands are not
     intended for use in scripting and CI. Instead, you should generate a secret
     key in the |Gel| Cloud UI or by running
     :ref:`ref_cli_edgedb_cloud_secretkey_create` and set the

diff --git a/docs/cli/edgedb_configure.rst b/docs/cli/edgedb_configure.rst
@@ -15,7 +15,7 @@ Configure the |Gel| server.
 Description
 ===========
 
-``gel configure`` is a terminal command used to alter the
+:gelcmd:`configure` is a terminal command used to alter the
 configuration of a |Gel| instance. There are three types of
 configuration actions that can be performed.
 

diff --git a/docs/cli/edgedb_database/edgedb_database_drop.rst b/docs/cli/edgedb_database/edgedb_database_drop.rst
@@ -22,7 +22,7 @@ Drop a :ref:`database <ref_datamodel_databases>`.
 Description
 ===========
 
-``gel database drop`` is a terminal command equivalent to
+:gelcmd:`database drop` is a terminal command equivalent to
 :eql:stmt:`drop database`.
 
 

diff --git a/docs/cli/edgedb_database/edgedb_database_wipe.rst b/docs/cli/edgedb_database/edgedb_database_wipe.rst
@@ -22,7 +22,7 @@ Destroy the contents of a :ref:`database <ref_datamodel_databases>`
 Description
 ===========
 
-``gel database wipe`` is a terminal command equivalent to
+:gelcmd:`database wipe` is a terminal command equivalent to
 :eql:stmt:`reset schema to initial`.
 
 The database wiped will be one of these values: the value passed for the

diff --git a/docs/cli/edgedb_database/index.rst b/docs/cli/edgedb_database/index.rst
@@ -5,7 +5,7 @@
 gel database
 ============
 
-The ``gel database`` group of commands contains various database
+The :gelcmd:`database` group of commands contains various database
 manipulation tools.
 
 .. note::

diff --git a/docs/cli/edgedb_describe/edgedb_describe_object.rst b/docs/cli/edgedb_describe/edgedb_describe_object.rst
@@ -15,7 +15,7 @@ Describe a named schema object.
 Description
 ===========
 
-``gel describe`` is a terminal command equivalent to
+:gelcmd:`describe` is a terminal command equivalent to
 :eql:stmt:`describe object <describe>` introspection command.
 
 

diff --git a/docs/cli/edgedb_describe/edgedb_describe_schema.rst b/docs/cli/edgedb_describe/edgedb_describe_schema.rst
@@ -16,7 +16,7 @@ database specified by the connection options.
 Description
 ===========
 
-``gel describe schema`` is a terminal command equivalent to
+:gelcmd:`describe schema` is a terminal command equivalent to
 :eql:stmt:`describe schema as sdl <describe>` introspection command.
 
 

diff --git a/docs/cli/edgedb_describe/index.rst b/docs/cli/edgedb_describe/index.rst
@@ -5,7 +5,7 @@
 gel describe
 ============
 
-The ``gel describe`` group of commands contains various schema
+The :gelcmd:`describe` group of commands contains various schema
 introspection tools.
 
 .. toctree::

diff --git a/docs/cli/edgedb_instance/edgedb_instance_create.rst b/docs/cli/edgedb_instance/edgedb_instance_create.rst
@@ -15,14 +15,14 @@ Initialize a new |Gel| instance.
 Description
 ===========
 
-``gel instance create`` is a terminal command for making a new Gel
+:gelcmd:`instance create` is a terminal command for making a new Gel
 instance and creating a corresponding credentials file in
-``<edgedb_config_dir>/credentials``. Run ``gel info`` to see the path to
+``<edgedb_config_dir>/credentials``. Run :gelcmd:`info` to see the path to
 ``<edgedb_config_dir>`` on your machine.
 
 .. note::
 
-    The ``gel instance create`` command is not intended for use with
+    The :gelcmd:`instance create` command is not intended for use with
     self-hosted instances. You can follow one of our :ref:`deployment guides
     <ref_guide_deployment>` for information on how to create one of these
     instances.

diff --git a/docs/cli/edgedb_instance/edgedb_instance_credentials.rst b/docs/cli/edgedb_instance/edgedb_instance_credentials.rst
@@ -15,7 +15,7 @@ Display instance credentials.
 Description
 ===========
 
-``gel instance credentials`` is a terminal command for displaying the
+:gelcmd:`instance credentials` is a terminal command for displaying the
 credentials of an |Gel| instance.
 
 

diff --git a/docs/cli/edgedb_instance/edgedb_instance_destroy.rst b/docs/cli/edgedb_instance/edgedb_instance_destroy.rst
@@ -15,12 +15,12 @@ Remove an |Gel| instance.
 Description
 ===========
 
-``gel instance destroy`` is a terminal command for removing an (or edgedb.toml)
+:gelcmd:`instance destroy` is a terminal command for removing an (or edgedb.toml)
 instance and all its data.
 
 .. note::
 
-    The ``gel instance destroy`` command is not intended for use with
+    The :gelcmd:`instance destroy` command is not intended for use with
     self-hosted instances.
 
 

diff --git a/docs/cli/edgedb_instance/edgedb_instance_link.rst b/docs/cli/edgedb_instance/edgedb_instance_link.rst
@@ -15,7 +15,7 @@ instance name to simplify future connections.
 Description
 ===========
 
-``gel instance link`` is a terminal command used to bind a set of
+:gelcmd:`instance link` is a terminal command used to bind a set of
 connection credentials to an instance name. This is typically used as
 a way to simplify connecting to remote |Gel| database instances.
 Usually there's no need to do this for local instances as
@@ -24,7 +24,7 @@ instance.
 
 .. note::
 
-    Unlike other ``gel instance`` sub-commands, ``gel instance link`` is
+    Unlike other :gelcmd:`instance` sub-commands, :gelcmd:`instance link` is
     recommended to link self-hosted instances. This can make other operations
     like migrations, dumps, and restores more convenient.
 

diff --git a/docs/cli/edgedb_instance/edgedb_instance_list.rst b/docs/cli/edgedb_instance/edgedb_instance_list.rst
@@ -15,7 +15,7 @@ Show all |Gel| instances.
 Description
 ===========
 
-``gel instance list`` is a terminal command that shows all the
+:gelcmd:`instance list` is a terminal command that shows all the
 registered |Gel| instances and some relevant information about them
 (status, port, etc.).
 

diff --git a/docs/cli/edgedb_instance/edgedb_instance_logs.rst b/docs/cli/edgedb_instance/edgedb_instance_logs.rst
@@ -15,12 +15,12 @@ Show instance logs.
 Description
 ===========
 
-``gel instance logs`` is a terminal command for displaying the logs
+:gelcmd:`instance logs` is a terminal command for displaying the logs
 for a given |Gel| instance.
 
 .. note::
 
-    The ``gel instance logs`` command is not intended for use with
+    The :gelcmd:`instance logs` command is not intended for use with
     self-hosted instances.
 
 

diff --git a/docs/cli/edgedb_instance/edgedb_instance_restart.rst b/docs/cli/edgedb_instance/edgedb_instance_restart.rst
@@ -15,12 +15,12 @@ Restart an |Gel| instance.
 Description
 ===========
 
-``gel instance restart`` is a terminal command for restarting an
+:gelcmd:`instance restart` is a terminal command for restarting an
 |Gel| instance.
 
 .. note::
 
-    The ``gel instance restart`` command is not intended for use with
+    The :gelcmd:`instance restart` command is not intended for use with
     self-hosted instances.
 
 

diff --git a/docs/cli/edgedb_instance/edgedb_instance_revert.rst b/docs/cli/edgedb_instance/edgedb_instance_revert.rst
@@ -17,13 +17,13 @@ Description
 
 When :ref:`ref_cli_edgedb_instance_upgrade` performs a major version
 upgrade on an instance the old instance data is kept around. The
-``gel instance revert`` command removes the new instance version and
+:gelcmd:`instance revert` command removes the new instance version and
 replaces it with the old copy. It also ensures that the previous
 version of |Gel| server is used to run it.
 
 .. note::
 
-    The ``gel instance revert`` command is not intended for use with
+    The :gelcmd:`instance revert` command is not intended for use with
     self-hosted instances.
 
 

diff --git a/docs/cli/edgedb_instance/edgedb_instance_start.rst b/docs/cli/edgedb_instance/edgedb_instance_start.rst
@@ -15,12 +15,12 @@ Start an |Gel| instance.
 Description
 ===========
 
-``gel instance start`` is a terminal command for starting a new
+:gelcmd:`instance start` is a terminal command for starting a new
 |Gel| instance.
 
 .. note::
 
-    The ``gel instance start`` command is not intended for use with
+    The :gelcmd:`instance start` command is not intended for use with
     self-hosted instances.
 
 

diff --git a/docs/cli/edgedb_instance/edgedb_instance_status.rst b/docs/cli/edgedb_instance/edgedb_instance_status.rst
@@ -15,7 +15,7 @@ Show instance information.
 Description
 ===========
 
-``gel instance status`` is a terminal command for displaying the
+:gelcmd:`instance status` is a terminal command for displaying the
 information about |Gel| instances.
 
 

diff --git a/docs/cli/edgedb_instance/edgedb_instance_stop.rst b/docs/cli/edgedb_instance/edgedb_instance_stop.rst
@@ -15,13 +15,13 @@ Stop an |Gel| instance.
 Description
 ===========
 
-``gel instance stop`` is a terminal command for stopping a running
+:gelcmd:`instance stop` is a terminal command for stopping a running
 |Gel| instance. This is a necessary step before
 :ref:`destroying <ref_cli_edgedb_instance_destroy>` an instance.
 
 .. note::
 
-    The ``gel instance stop`` command is not intended for use with
+    The :gelcmd:`instance stop` command is not intended for use with
     self-hosted instances.
 
 

diff --git a/docs/cli/edgedb_instance/edgedb_instance_unlink.rst b/docs/cli/edgedb_instance/edgedb_instance_unlink.rst
@@ -14,7 +14,7 @@ Unlink from a previously linked remote Gel instance.
 Description
 ===========
 
-``gel instance unlink`` is a terminal command used to unlink a
+:gelcmd:`instance unlink` is a terminal command used to unlink a
 remote instance. This removes the instance name from the list of valid
 instances.
 

diff --git a/docs/cli/edgedb_instance/edgedb_instance_upgrade.rst b/docs/cli/edgedb_instance/edgedb_instance_upgrade.rst
@@ -20,7 +20,7 @@ bulk.
 
 .. note::
 
-    The ``gel instance upgrade`` command is not intended for use with
+    The :gelcmd:`instance upgrade` command is not intended for use with
     self-hosted instances.
 
 

diff --git a/docs/cli/edgedb_instance/index.rst b/docs/cli/edgedb_instance/index.rst
@@ -4,12 +4,12 @@
 gel instance
 ============
 
-The ``gel instance`` group of commands contains all sorts of tools
+The :gelcmd:`instance` group of commands contains all sorts of tools
 for managing |Gel| instances.
 
 .. note::
 
-    Most commands in the ``gel instance`` command group are not intended to
+    Most commands in the :gelcmd:`instance` command group are not intended to
     manage self-hosted instances. See individual commands for more details.
 
 .. toctree::

diff --git a/docs/cli/edgedb_list.rst b/docs/cli/edgedb_list.rst
@@ -15,7 +15,7 @@ List matching database objects by name and type.
 Description
 ===========
 
-The ``gel list`` group of commands contains tools for listing
+The :gelcmd:`list` group of commands contains tools for listing
 database objects by matching name or type. The sub-commands are
 organized by the type of the objects listed.
 

diff --git a/docs/cli/edgedb_migrate.rst b/docs/cli/edgedb_migrate.rst
@@ -11,7 +11,7 @@ database using this command.
 .. warning:: Gel Cloud CI users and scripters
 
     When scripting a ``migrate``/``migration apply`` for an |Gel| Cloud
-    instance, do not use ``gel login`` to authenticate. Instead, you should
+    instance, do not use :gelcmd:`login` to authenticate. Instead, you should
     generate a secret key in the Gel Cloud UI or by running
     :ref:`ref_cli_edgedb_cloud_secretkey_create` and set the
     ``EDGEDB_SECRET_KEY`` environment variable to your secret key. Once this

diff --git a/docs/cli/edgedb_migration/edgedb_migration_apply.rst b/docs/cli/edgedb_migration/edgedb_migration_apply.rst
@@ -19,7 +19,7 @@ target instance.
 .. warning:: Gel Cloud CI users and scripters
 
     When scripting a ``migrate``/``migration apply`` for an |Gel| Cloud
-    instance, do not use ``gel login`` to authenticate. Instead, you should
+    instance, do not use :gelcmd:`login` to authenticate. Instead, you should
     generate a secret key in the Gel Cloud UI or by running
     :ref:`ref_cli_edgedb_cloud_secretkey_create` and set the
     ``EDGEDB_SECRET_KEY`` environment variable to your secret key. Once this

diff --git a/docs/cli/edgedb_migration/edgedb_migration_extract.rst b/docs/cli/edgedb_migration/edgedb_migration_extract.rst
@@ -7,7 +7,7 @@ gel migration extract
 
 Extract migration history from the database and write it to
 ``/dbschema/migrations``. Useful when a direct DDL command has been used to
-change the schema and now ``gel migrate`` will not comply because the
+change the schema and now :gelcmd:`migrate` will not comply because the
 database migration history is ahead of the migration history inside
 ``/dbschema/migrations``.
 

diff --git a/docs/cli/edgedb_project/edgedb_project_init.rst b/docs/cli/edgedb_project/edgedb_project_init.rst
@@ -31,7 +31,7 @@ logging in using :ref:`ref_cli_edgedb_cloud_login`.
 To create a Cloud instance, your instance name should be in the format
 ``<org-name>/<instance-name>``. Cloud instance names may contain alphanumeric
 characters and hyphens (i.e., ``-``). You can provide this Cloud instance name
-through the interactive project initiation by running ``gel project init``
+through the interactive project initiation by running :gelcmd:`project init`
 or by providing it via the ``--server-instance`` option.
 
 .. note::

diff --git a/docs/cli/edgedb_project/edgedb_project_upgrade.rst b/docs/cli/edgedb_project/edgedb_project_upgrade.rst
@@ -30,7 +30,7 @@ if upgrading from nightly to the stable version).
 
 .. note::
 
-    The ``gel project upgrade`` command is not intended for use with
+    The :gelcmd:`project upgrade` command is not intended for use with
     self-hosted instances.
 
 

diff --git a/docs/cli/edgedb_query.rst b/docs/cli/edgedb_query.rst
@@ -15,7 +15,7 @@ Execute one or more EdgeQL queries.
 Description
 ===========
 
-``gel query`` is a terminal command used to execute EdgeQL queries
+:gelcmd:`query` is a terminal command used to execute EdgeQL queries
 provided as space-separated strings.
 
 

diff --git a/docs/cli/edgedb_restore.rst b/docs/cli/edgedb_restore.rst
@@ -15,7 +15,7 @@ Restore a |Gel| branch from a backup file.
 Description
 ===========
 
-``gel restore`` is a terminal command used to restore an Gel database
+:gelcmd:`restore` is a terminal command used to restore an Gel database
 branch (or database pre-v5) from a backup file. The backup is restored to the
 currently active branch (or to the currently connected database pre-v5).
 

diff --git a/docs/cli/edgedb_server/edgedb_server_info.rst b/docs/cli/edgedb_server/edgedb_server_info.rst
@@ -15,7 +15,7 @@ Show server information.
 Description
 ===========
 
-``gel server info`` is a terminal command for displaying the
+:gelcmd:`server info` is a terminal command for displaying the
 information about installed |Gel| servers.