Updated
Reference for the pgdesign serve command — usage, flags, arguments, and examples for the serve subcommand of the pgdesign CLI.
#pgdesign serve
Start the pgdesign HTTP API server and web interface
Effect: read_only
#Flags
| Name | Short | Type | Default | Env | Description |
|---|---|---|---|---|---|
--db | str | PGDESIGN_DB | PostgreSQL connection URL for the target database server (omit for DB-free project mode) | ||
--port | int | 8080 | TCP port number for the HTTP API server to listen on | ||
--bind | str | 127.0.0.1 | Network interface address to bind the HTTP server to. Defaults to 127.0.0.1 (loopback only). WARNING: the server has NO AUTHENTICATION; binding to a non-loopback address (e.g. 0.0.0.0) exposes the schema, database statistics, and diff endpoints to anyone who can reach that address. | ||
--schema | str | PostgreSQL schema name to serve via the API (repeatable) | |||
--timeout | int | 30 | Maximum time in seconds for each HTTP request to complete |