diff --git a/CHANGELOG.md b/CHANGELOG.md index 2e293ff5e91..2e25685c2af 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -15,6 +15,7 @@ This project adheres to [Semantic Versioning](http://semver.org/). - #2676, Performance improvement on bulk json inserts, around 10% increase on requests per second by removing `json_typeof` from write queries - @steve-chavez - #3248, Add more config examples to CLI - @taimoorzaeem + Now accepts ``--example-file``, ``--example-db``, and ``--example-env`` + + Add docs page for CLI ### Fixed diff --git a/docs/index.rst b/docs/index.rst index 16c3508b458..b0fb672cbc6 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 63d935ec6b1..d24804de56d 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 00000000000..cb2b00892b6 --- /dev/null +++ b/docs/references/cli.rst @@ -0,0 +1,41 @@ +.. _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|--example-file] + $ postgrest [--example-db] + $ postgrest [--example-env] + +These commands show the example configuration file of the selected type. + + +Config or Schema Cache +~~~~~~~~~~~~~~~~~~~~~~ + +.. code:: bash + + $ postgrest [--dump-config|--dump-schema-cache] [FILENAME] + +Here ``FILENAME`` is the path to configuration file.