-
-
Notifications
You must be signed in to change notification settings - Fork 1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
8414330
commit a2c003f
Showing
4 changed files
with
44 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -15,6 +15,7 @@ Cardano | |
casted | ||
cd | ||
centric | ||
CLI | ||
coercible | ||
conf | ||
Cloudflare | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |