diff --git a/docs/ai/index.rst b/docs/ai/index.rst index b5f10e3cabb..79b77d4b356 100644 --- 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 index a58fa7fd4e6..8abcc94f159 100644 --- 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 ``/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 ```` 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 index 02081e0b244..5e1fb0509ed 100644 --- 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 `. 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 index a410724987c..68658dbd8c7 100644 --- 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 index 50cbdf9af96..9dfbb511fcb 100644 --- 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 index 32b3d5c6c0f..1571a85bc3f 100644 --- 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 index 3e6e14f879a..64f562705d1 100644 --- 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 index 5764b9a3def..d05bba659e5 100644 --- 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 index 6aa10ba7a12..a8f7b9c2651 100644 --- 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 `. 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 index 2a2e511470c..b2c701dce62 100644 --- 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 ` 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 index 69a1658e220..d339165fa86 100644 --- 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 index 97f76ce27b5..220aae4270c 100644 --- 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 ` introspection command. diff --git a/docs/cli/edgedb_describe/edgedb_describe_schema.rst b/docs/cli/edgedb_describe/edgedb_describe_schema.rst index df2924e9e21..f80f375ea45 100644 --- 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 ` introspection command. diff --git a/docs/cli/edgedb_describe/index.rst b/docs/cli/edgedb_describe/index.rst index b82e87ce87c..fbe74758f85 100644 --- 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 index 4fc5e4bc0d9..71bd7d64cb8 100644 --- 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 -``/credentials``. Run ``gel info`` to see the path to +``/credentials``. Run :gelcmd:`info` to see the path to ```` 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 ` 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 index 58c7d68ce0c..fff07279bb2 100644 --- 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 index 6c1477ff681..01b72110650 100644 --- 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 index f7c69383425..0f0f63c685c 100644 --- 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 index bbbaa8619c1..a7005ed5a3d 100644 --- 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 index dd6ee6338bf..9ec07b71c88 100644 --- 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 index ed57ca9244f..f00dc09e743 100644 --- 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 index 85aa2ed7489..5b8c479c18d 100644 --- 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 index c8d45c470b7..e4e53762216 100644 --- 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 index f10126aa630..5d0bb9a3f7c 100644 --- 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 index 17ed385b548..b27a4d365d2 100644 --- 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 ` 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 index 59ff9c01084..2e2adcc110f 100644 --- 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 index 21b5855a0d5..dc2c4c1740d 100644 --- 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 index af4711968a1..dbb44c31071 100644 --- 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 index 1a3bab4a716..548d11e60ab 100644 --- 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 index c9acaddc674..f44ece4bb4e 100644 --- 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 index 5ac3d63ddf8..d2757636ef0 100644 --- 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 index ee6c2438dfa..81006893a67 100644 --- 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 index cad2ce6ed52..6bdf7621bd5 100644 --- 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 ``/``. 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 index 11e45732d9d..340776ee426 100644 --- 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 index 070f6af5bba..ef0f12cb745 100644 --- 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 index c0a0410680d..34bf8c9f606 100644 --- 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 index 60e0ac7d8b3..f28b93cd4a9 100644 --- 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. diff --git a/docs/cli/edgedb_server/edgedb_server_install.rst b/docs/cli/edgedb_server/edgedb_server_install.rst index 412291a942b..16b5b1c2ebe 100644 --- a/docs/cli/edgedb_server/edgedb_server_install.rst +++ b/docs/cli/edgedb_server/edgedb_server_install.rst @@ -15,7 +15,7 @@ Install |Gel| server. Description =========== -``gel server install`` is a terminal command for installing a +:gelcmd:`server install` is a terminal command for installing a specific |Gel| server version. diff --git a/docs/cli/edgedb_server/edgedb_server_uninstall.rst b/docs/cli/edgedb_server/edgedb_server_uninstall.rst index fafe43537a8..7fbb0f6ccca 100644 --- a/docs/cli/edgedb_server/edgedb_server_uninstall.rst +++ b/docs/cli/edgedb_server/edgedb_server_uninstall.rst @@ -15,7 +15,7 @@ Uninstall |Gel| server. Description =========== -``gel server uninstall`` is a terminal command for removing a +:gelcmd:`server uninstall` is a terminal command for removing a specific |Gel| server version from your system. diff --git a/docs/cli/edgedb_server/index.rst b/docs/cli/edgedb_server/index.rst index 8164e003a40..5d3856139fd 100644 --- a/docs/cli/edgedb_server/index.rst +++ b/docs/cli/edgedb_server/index.rst @@ -4,7 +4,7 @@ gel server ========== -The ``gel server`` group of commands contains all sorts of tools +The :gelcmd:`server` group of commands contains all sorts of tools for managing |Gel| server versions. .. toctree:: diff --git a/docs/cli/edgedb_ui.rst b/docs/cli/edgedb_ui.rst index f6db5840abe..f4f170ff53d 100644 --- a/docs/cli/edgedb_ui.rst +++ b/docs/cli/edgedb_ui.rst @@ -15,7 +15,7 @@ Open the |Gel| UI of the current instance in your default browser. Description =========== -``gel ui`` is a terminal command used to open the |Gel| UI in your default +:gelcmd:`ui` is a terminal command used to open the |Gel| UI in your default browser. Alternatively, it can be used to print the UI URL with the ``--print-url`` option. diff --git a/docs/cli/index.rst b/docs/cli/index.rst index dabec4c66df..a7f44fad4b1 100644 --- a/docs/cli/index.rst +++ b/docs/cli/index.rst @@ -74,7 +74,7 @@ macOS run: $ rm "$(which gel)" -To remove all configuration files, run ``gel info`` to list the directories +To remove all configuration files, run :gelcmd:`info` to list the directories where |Gel| stores data, then use ``rm -rf `` to delete those directories. diff --git a/docs/cli/network.rst b/docs/cli/network.rst index 8ae0717d57f..831d8b28cb6 100644 --- a/docs/cli/network.rst +++ b/docs/cli/network.rst @@ -67,8 +67,8 @@ logging facility can be used:: .. _ref_cli_edgedb_net_server: -``gel server`` and ``gel self upgrade`` -============================================= +"gel server" and "gel self upgrade" +=================================== Generally these commands do requests with exactly the headers like :ref:`version check `. @@ -90,7 +90,7 @@ Data sources that can be used indirectly: data from any sources listed in repositories configured in the system. -To avoid reaching these hosts, avoid using: ``gel server`` and -``gel self upgrade`` subcommands. These commands only simplify +To avoid reaching these hosts, avoid using: :gelcmd:`server` and +:gelcmd:`self upgrade` subcommands. These commands only simplify installation and maintenance of the installations. All |Gel| features are available without using them. diff --git a/docs/clients/http/index.rst b/docs/clients/http/index.rst index 51c6adead46..6805cb3c93c 100644 --- a/docs/clients/http/index.rst +++ b/docs/clients/http/index.rst @@ -36,7 +36,7 @@ Your instance can now receive EdgeQL queries over HTTP at Here's how to determine your local |Gel| instance's HTTP server URL: - The ``hostname`` will be ``localhost`` - - Find the ``port`` by running ``gel instance list``. This will print a + - Find the ``port`` by running :gelcmd:`instance list`. This will print a table of all |Gel| instances on your machine, including their associated port number. - The default ``branch-name`` will be ``main``, and after initializing @@ -52,7 +52,7 @@ Your instance can now receive EdgeQL queries over HTTP at To determine the URL of a self-hosted remote instance you have linked with the CLI, you can get both the hostname and port of the instance from the - "Port" column of the ``gel instance list`` table (formatted as + "Port" column of the :gelcmd:`instance list` table (formatted as ``:``). The same guidance on local branch names applies here. diff --git a/docs/clients/js/driver.rst b/docs/clients/js/driver.rst index 0868a97f99d..3d5a2afe05d 100644 --- a/docs/clients/js/driver.rst +++ b/docs/clients/js/driver.rst @@ -45,7 +45,7 @@ Connections Notice we didn't pass any arguments into ``createClient``. That's intentional. -**In development**, we recommend using ``gel project init`` to create an +**In development**, we recommend using :gelcmd:`project init` to create an instance and link it to your project directory. As long as you're inside this directory, ``createClient()`` with auto-detect the project and connect to the associated instance automatically. diff --git a/docs/clients/js/generation.rst b/docs/clients/js/generation.rst index 6b8502080d8..aa09c28788a 100644 --- a/docs/clients/js/generation.rst +++ b/docs/clients/js/generation.rst @@ -84,7 +84,7 @@ analyzer in JavaScript—which we don't intend to do anytime soon. Make sure your development database is up-to-date with your latest schema before running a generator! -If you're using ``gel project init``, the connection is automatically handled +If you're using :gelcmd:`project init`, the connection is automatically handled for you. Otherwise, you'll need to explicitly pass connection information via environment variables or CLI flags, just like any other CLI command. See :ref:`Client Libraries > Connection ` for guidance. diff --git a/docs/datamodel/access_policies.rst b/docs/datamodel/access_policies.rst index 7b9b7deb349..b33d6911249 100644 --- a/docs/datamodel/access_policies.rst +++ b/docs/datamodel/access_policies.rst @@ -598,7 +598,7 @@ You may disable all access policies by setting the ``apply_access_policies`` You may also toggle access policies using the "Disable Access Policies" checkbox in the "Config" dropdown in the Gel UI (accessible by running -the CLI command ``gel ui`` from inside your project). This is the most +the CLI command :gelcmd:`ui` from inside your project). This is the most convenient way to temporarily disable access policies since it applies only to your UI session. diff --git a/docs/guides/tutorials/chatgpt_bot.rst b/docs/guides/tutorials/chatgpt_bot.rst index 8ab6b4cec2b..b95110e7bdb 100644 --- a/docs/guides/tutorials/chatgpt_bot.rst +++ b/docs/guides/tutorials/chatgpt_bot.rst @@ -247,7 +247,7 @@ that instance. "inactive"; the status will change to "running" automatically when you connect to the instance.) - Confirm you can connect to the created instance by running |gelcmd| in the - terminal to connect to it via REPL or by running ``gel ui`` to connect + terminal to connect to it via REPL or by running :gelcmd:`ui` to connect using the UI. diff --git a/docs/reference/http.rst b/docs/reference/http.rst index e5e21a52db8..5174c56758d 100644 --- a/docs/reference/http.rst +++ b/docs/reference/http.rst @@ -19,13 +19,13 @@ Here's how to determine your *local* Gel instance's HTTP server URL: - The ``hostname`` will be ``localhost`` -- Find the ``port`` by running ``gel instance list``. This will print a +- Find the ``port`` by running :gelcmd:`instance list`. This will print a table of all Gel instances on your machine, including their associated port number. To determine the URL of a remote instance you have linked with the CLI, you can get both the hostname and port of the instance from the "Port" column -of the ``gel instance list`` table (formatted as ``:``). +of the :gelcmd:`instance list` table (formatted as ``:``). The same guidance on local :versionreplace:`database;5.0:branch` names applies to remote instances. diff --git a/docs/reference/sql_adapter.rst b/docs/reference/sql_adapter.rst index 431b815d13c..bf4bfe269eb 100644 --- a/docs/reference/sql_adapter.rst +++ b/docs/reference/sql_adapter.rst @@ -30,7 +30,7 @@ for the database. .. versionchanged:: 5.0 Here's how you might connect to a local instance on port 10701 (determined - by running ``gel instance list``) on a branch ``main`` using the + by running :gelcmd:`instance list`) on a branch ``main`` using the ``psql`` CLI: .. code-block:: bash