Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add docs page for CLI #3461

Merged
merged 1 commit into from
Apr 29, 2024
Merged

docs: add docs page for CLI #3461

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/index.rst
View file
Open in desktop
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
View file
Open in desktop
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
46 changes: 46 additions & 0 deletions docs/references/cli.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.
Loading