docs: add docs page for CLI
This commit is contained in:
committed by
Steve Chavez
parent
40bd9a7769
commit
7e5fd317e6
@@ -147,6 +147,7 @@ Technical references for PostgREST's functionality.
|
|||||||
|
|
||||||
references/auth.rst
|
references/auth.rst
|
||||||
references/api.rst
|
references/api.rst
|
||||||
|
references/cli.rst
|
||||||
references/transactions.rst
|
references/transactions.rst
|
||||||
references/connection_pool.rst
|
references/connection_pool.rst
|
||||||
references/schema_cache.rst
|
references/schema_cache.rst
|
||||||
|
|||||||
@@ -15,6 +15,7 @@ Cardano
|
|||||||
casted
|
casted
|
||||||
cd
|
cd
|
||||||
centric
|
centric
|
||||||
|
CLI
|
||||||
coercible
|
coercible
|
||||||
conf
|
conf
|
||||||
Cloudflare
|
Cloudflare
|
||||||
|
|||||||
@@ -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.
|
||||||
Reference in New Issue
Block a user