CLI

PostgREST provides a CLI to start and run your postgrest service. The CLI provides the commands listed below:

CLI Commands

Help and Version

$ postgrest [-h|--help]
$ postgrest [-v|--version]

Example Config

$ postgrest [-e|--example]

These commands show the example configuration file.

Config

$ postgrest [--dump-config] [FILENAME]

Here FILENAME is the path to configuration file.

Schema Cache

$ postgrest [--dump-schema] [FILENAME]

Here FILENAME is the path to configuration file.