Getting Started
#
Installationnpm install @pgtyped/cli @pgtyped/runtime typescript
(TS is a required peer dependency)- Create a PgTyped
config.json
file. - Run
npx pgtyped -w -c config.json
to start PgTyped in watch mode.
#
ConfigurationPgTyped requires a config.json
file to run, a basic config file looks like this:
config.json
Refer to the CLI page for more info on the config file, available CLI flags and environment variables.
note
If you are having trouble configuring PgTyped, you can refer to the example app for a preconfigured example.