Consolidate Presto CLI documentation on clients/presto-cli.rst page

dnskr · steveburnett · commit bd095dc8258b · 2025-02-24T14:11:01.000-05:00
diff --git a/presto-docs/src/main/sphinx/clients.rst b/presto-docs/src/main/sphinx/clients.rst
@@ -1,6 +1,6 @@
-**************
-Presto Clients
-**************
+*******
+Clients
+*******
 
 .. toctree::
     :maxdepth: 1
diff --git a/presto-docs/src/main/sphinx/clients/presto-cli.rst b/presto-docs/src/main/sphinx/clients/presto-cli.rst
@@ -1,6 +1,6 @@
-======================
-Command Line Interface
-======================
+==========
+Presto CLI
+==========
 
 .. contents::
     :local:
@@ -10,27 +10,46 @@ Command Line Interface
 Overview
 ========
 
-The Presto Command Line Interface (CLI) is a terminal-based interactive shell 
-for running queries, and is a
-`self-executing <http://skife.org/java/unix/2011/06/20/really_executable_jars.html>`_
-JAR file that acts like a normal UNIX executable. The Presto CLI communicates 
-with the Presto server over HTTP using a REST API, documented at 
-:doc:`Presto Client REST API </develop/client-protocol>`.
+The Presto Command Line Interface (CLI) is a terminal-based interactive shell for running queries.
+It is a `self-executing <http://skife.org/java/unix/2011/06/20/really_executable_jars.html>`_
+JAR file that acts like a normal UNIX executable and communicates with the Presto server
+over HTTP using :doc:`Presto Client REST API </develop/client-protocol>`.
+
+Installation
+======================
+
+Download :maven_download:`cli`.
+
+Rename the JAR file to ``presto`` with the following command
+(replace ``*`` with the version number of the downloaded jar file):
+
+.. code-block:: none
+
+    mv presto-cli-*-executable.jar presto
+
+Use ``chmod +x`` to make the renamed file executable:
+
+.. code-block:: none
+
+    chmod +x presto
+
+Running the Presto CLI
+======================
+
+Start the Presto CLI using the name you gave it using the ``mv`` command:
+
+.. code-block:: none
 
-To install the Presto CLI, see :doc:`/installation/cli`.
+    ./presto
 
-Configuration
-=============
+The Presto CLI starts and displays the prompt ``presto>``.
 
-The Presto CLI paginates query results using the ``less`` program, which 
-is configured with preset options. To change the pagination of query results, set the 
-environment variable ``PRESTO_PAGER`` to the name of a different program such as ``more``, 
-or set it to an empty value to disable pagination.
+To exit the Presto CLI, enter ``quit``.
 
-Connect to a Presto server using the Presto CLI
-===============================================
+Connect to a Presto server
+==========================
 
-To connect to a Presto server, run the CLI with the ``--server`` option.  
+To connect to a Presto server, run the Presto CLI with the ``--server`` option.
 
 .. code-block:: none
 
@@ -39,14 +58,18 @@ To connect to a Presto server, run the CLI with the ``--server`` option.
 ``localhost:8080`` is the default for a Presto server, so if you have a Presto server running locally you can 
 leave it off. 
 
-To connect to a remote Presto server, use the Presto endpoint URL as in 
-the following example command:
+To connect to a remote Presto server, use the Presto endpoint URL as in the following example command:
 
 .. code-block:: none
 
     ./presto --server http://www.example.net:8080
 
+Pagination
+==========
 
+The Presto CLI paginates query results using the ``less`` program, which is configured with preset options.
+To change the pagination of query results, set the environment variable ``PRESTO_PAGER``
+to the name of a different program such as ``more``, or set it to an empty value to disable pagination.
 
 Examples
 ========
@@ -66,7 +89,7 @@ JSON format in a file named ``plan.json``.
 Online Help
 ===========
 
-Run the CLI with the ``--help`` option to see the online help.
+Run the Presto CLI with the ``--help`` option to see the online help.
 
 .. code-block:: none
 
diff --git a/presto-docs/src/main/sphinx/connector/kafka-tutorial.rst b/presto-docs/src/main/sphinx/connector/kafka-tutorial.rst
@@ -116,7 +116,7 @@ Because the Kafka tables all have the ``tpch.`` prefix in the configuration,
 the tables are in the ``tpch`` schema. The connector is mounted into the
 ``kafka`` catalog because the properties file is named ``kafka.properties``.
 
-Start the :doc:`Presto CLI </installation/cli>`:
+Start the :doc:`/clients/presto-cli`:
 
 .. code-block:: none
 
diff --git a/presto-docs/src/main/sphinx/installation.rst b/presto-docs/src/main/sphinx/installation.rst
@@ -6,7 +6,6 @@ Installation
     :maxdepth: 1
 
     installation/deployment
-    installation/cli
     installation/jdbc
     installation/benchmark-driver
     installation/tableau
diff --git a/presto-docs/src/main/sphinx/installation/cli.rst b/presto-docs/src/main/sphinx/installation/cli.rst
diff --git a/presto-docs/src/main/sphinx/installation/deploy-brew.rst b/presto-docs/src/main/sphinx/installation/deploy-brew.rst
@@ -93,7 +93,7 @@ To run the Presto CLI, run the following command:
 
 The Presto CLI starts and displays the prompt ``presto>``. 
 
-For more information on the Presto CLI, see :doc:`Command Line Interface <cli>`.
+For more information, see :doc:`/clients/presto-cli`.
 
 Deploy Presto on an Apple Silicon Mac using Homebrew 
 ----------------------------------------------------
@@ -192,4 +192,4 @@ To run the Presto CLI, run the following command:
 
 The Presto CLI starts and displays the prompt ``presto>``. 
 
-For more information on the Presto CLI, see :doc:`Command Line Interface <cli>`.
+For more information, see :doc:`/clients/presto-cli`.
diff --git a/presto-docs/src/main/sphinx/release/release-0.54.rst b/presto-docs/src/main/sphinx/release/release-0.54.rst
@@ -6,7 +6,7 @@ Release 0.54
   the state of all nodes as seen by the coordinator's failure detector.
   Access ``/v1/node`` to see all nodes, or ``/v1/node/failed`` to see failed nodes.
 
-* Prevent the :doc:`/installation/cli` from hanging when the server goes away.
+* Prevent the :doc:`/clients/presto-cli` from hanging when the server goes away.
 
 * Add Hive connector ``hive-hadoop1`` for Apache Hadoop 1.x.
 
diff --git a/presto-docs/src/main/sphinx/release/release-0.60.rst b/presto-docs/src/main/sphinx/release/release-0.60.rst
@@ -16,7 +16,7 @@ anymore.
 USE CATALOG and USE SCHEMA
 --------------------------
 
-The :doc:`/installation/cli` now supports ``USE CATALOG`` and
+The :doc:`/clients/presto-cli` now supports ``USE CATALOG`` and
 ``USE SCHEMA``.
 
 
diff --git a/presto-docs/src/main/sphinx/security/cli.rst b/presto-docs/src/main/sphinx/security/cli.rst
@@ -2,8 +2,8 @@
 CLI Kerberos Authentication
 ===========================
 
-The Presto :doc:`/installation/cli` can connect to a :doc:`Presto coordinator
-</security/server>` that has Kerberos authentication enabled.
+The :doc:`/clients/presto-cli` can connect to a Presto
+:doc:`coordinator with Kerberos authentication </security/server>` enabled.
 
 Environment Configuration
 -------------------------
