docs: shorten CLI

This commit is contained in:
steve-chavez
2024-05-24 18:05:45 -05:00
committed by Steve Chavez
parent 1c371d7340
commit a51a74b3c1
+24 -19
View File
@@ -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:
CLI Commands
------------
Help and Version
~~~~~~~~~~~~~~~~
Help
----
.. code:: bash
$ postgrest [-h|--help]
Shows all the commands available.
Version
-------
.. code:: bash
$ 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.