diff --git a/docs/index.rst b/docs/index.rst index 16c3508b45..b0fb672cbc 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -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 diff --git a/docs/postgrest.dict b/docs/postgrest.dict index 63d935ec6b..d24804de56 100644 --- a/docs/postgrest.dict +++ b/docs/postgrest.dict @@ -15,6 +15,7 @@ Cardano casted cd centric +CLI coercible conf Cloudflare diff --git a/docs/references/cli.rst b/docs/references/cli.rst new file mode 100644 index 0000000000..823a54c1a4 --- /dev/null +++ b/docs/references/cli.rst @@ -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.