Skip to content

Commit

Permalink
docs: shorten CLI
Browse files Browse the repository at this point in the history
  • Loading branch information
steve-chavez committed May 24, 2024
1 parent 1c371d7 commit a51a74b
Showing 1 changed file with 23 additions and 18 deletions.
41 changes: 23 additions & 18 deletions docs/references/cli.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.

0 comments on commit a51a74b

Please sign in to comment.