From a51a74b3c1a386a33db4200ecabdf8ce5588b0d3 Mon Sep 17 00:00:00 2001 From: steve-chavez Date: Fri, 24 May 2024 17:25:40 -0500 Subject: [PATCH] docs: shorten CLI --- docs/references/cli.rst | 41 +++++++++++++++++++++++------------------ 1 file changed, 23 insertions(+), 18 deletions(-) diff --git a/docs/references/cli.rst b/docs/references/cli.rst index 823a54c1a4..8cc8c6c60e 100644 --- a/docs/references/cli.rst +++ b/docs/references/cli.rst @@ -3,44 +3,49 @@ CLI === -PostgREST provides a CLI to start and run your postgrest service. The CLI provides the commands listed below: +PostgREST provides a CLI with the commands listed below: -.. _cli_commands: +Help +---- -CLI Commands ------------- +.. code:: bash + + $ postgrest [-h|--help] -Help and Version -~~~~~~~~~~~~~~~~ +Shows all the commands available. + +Version +------- .. code:: bash - $ postgrest [-h|--help] $ postgrest [-v|--version] -Example Config -~~~~~~~~~~~~~~ +Prints the PostgREST version. + +Example +------- .. code:: bash $ postgrest [-e|--example] -These commands show the example configuration file. +Shows example configuration options. -Config -~~~~~~ +Dump Config +----------- .. code:: bash - $ postgrest [--dump-config] [FILENAME] + $ postgrest [--dump-config] -Here ``FILENAME`` is the path to configuration file. +Dumps the loaded :ref:`configuration` values, considering the configuration file, environment variables and :ref:`in_db_config`. -Schema Cache -~~~~~~~~~~~~ +Dump Schema +----------- .. code:: bash - $ postgrest [--dump-schema] [FILENAME] + $ postgrest [--dump-schema] -Here ``FILENAME`` is the path to configuration file. +Dumps the schema cache in JSON format.