cli.rst

CLI

PostgREST provides a CLI with the commands listed below:

Help

$ postgrest [-h|--help]

Shows all the commands available.

Version

$ postgrest [-v|--version]

Prints the PostgREST version.

Example

$ postgrest [-e|--example]

Shows example configuration options.

Dump Config

$ postgrest [--dump-config]

Dumps the loaded configuration values, considering the configuration file, environment variables and in_db_config.

Dump Schema

$ postgrest [--dump-schema]

Dumps the schema cache in JSON format.