Skip to content

Commit

Permalink
docs: add docs page for CLI
Browse files Browse the repository at this point in the history
  • Loading branch information
taimoorzaeem committed Apr 13, 2024
1 parent 8414330 commit a2c003f
Show file tree
Hide file tree
Showing 4 changed files with 44 additions and 0 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
1 change: 1 addition & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions docs/postgrest.dict
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ Cardano
casted
cd
centric
CLI
coercible
conf
Cloudflare
Expand Down
41 changes: 41 additions & 0 deletions docs/references/cli.rst
Original file line number Diff line number Diff line change
@@ -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.

0 comments on commit a2c003f

Please sign in to comment.