docs: add docs page for CLI

This commit is contained in:
Taimoor Zaeem
2024-04-29 12:51:54 -05:00
committed by Steve Chavez
parent 40bd9a7769
commit 7e5fd317e6
3 changed files with 48 additions and 0 deletions
+1
View File
@@ -147,6 +147,7 @@ Technical references for PostgREST's functionality.
references/auth.rst
references/api.rst
references/cli.rst
references/transactions.rst
references/connection_pool.rst
references/schema_cache.rst
+1
View File
@@ -15,6 +15,7 @@ Cardano
casted
cd
centric
CLI
coercible
conf
Cloudflare
+46
View File
@@ -0,0 +1,46 @@
.. _cli:
CLI
===
PostgREST provides a CLI to start and run your postgrest service. The CLI provides the commands listed below:
.. _cli_commands:
CLI Commands
------------
Help and Version
~~~~~~~~~~~~~~~~
.. code:: bash
$ postgrest [-h|--help]
$ postgrest [-v|--version]
Example Config
~~~~~~~~~~~~~~
.. code:: bash
$ postgrest [-e|--example]
These commands show the example configuration file.
Config
~~~~~~
.. code:: bash
$ postgrest [--dump-config] [FILENAME]
Here ``FILENAME`` is the path to configuration file.
Schema Cache
~~~~~~~~~~~~
.. code:: bash
$ postgrest [--dump-schema] [FILENAME]
Here ``FILENAME`` is the path to configuration file.