pgtyped CLI can be launched in build or watch mode.
Watch mode is most useful for a local development workflow,
while build mode can be used for generating types when running CI.
The CLI supports a number of flags:
--config config_file_path.jsonto pass the config file path.
--watchto start in watch mode.
--file file_path.tsif you only want to process one file (which can be useful when working on a big project). Incompatible with watch mode. Uses transforms defined in the config file to determine the mode and emit template, so a file path that doesn't fit the include glob patterns will not be processed.
--urito specify a PG connection URI (overriding the config value).
--helpfor a quick flag reference.
--versionto show the version number.
PgTyped supports common PostgreSQL environment variables:
These variables will override values provided in
By default, PgTyped saves generated files in the same folder as the source files it parses.
This behavior can be customized using the
emitTemplate config parameter.
In that template, four parameters are available for interpolation:
For example, when parsing source/query file
/home/user/dir/file.sql, these parameters are assigned the following values:
By default, if enabled it will attempt to verify the SSL connection with the local certificates on the machine.
Options can also be provided to customize the certificate used or to ignore SSL errors. More information about options can be found here.
Sample configuration files have been provided below.