pgls-vscode

VSCode client for the pgls PostgreSQL language server.

Provides completion, hover, goto-definition, document links, and diagnostics for SQL — both inside .sql files and inside SQL string literals embedded in .go source.

Install

Search for pgls in the VSCode Extensions panel, or open the Marketplace listing directly.

Prerequisite

The extension shells out to the pgls server binary. Install it following the pgls install instructions — either drop a pre-built archive on your $PATH or go install it from source.

The extension expects pgls to be on $PATH; set pgls.command in your VSCode settings to point elsewhere if it lives somewhere custom.

Install from VSIX (manual)

npm install
npm run compile
npm run package        # produces pgls-vscode-<version>.vsix

In VSCode: Extensions → ... → Install from VSIX...

Install (development)

npm install
npm run compile

Open this folder in VSCode and press F5 to launch an Extension Development Host with the extension loaded.

Schema configuration

The extension activates only when the workspace contains a .pgls.json at one of its folder roots — that file is pgls's opt-in signal. Workspaces without .pgls.json see nothing from this extension, so no idle language server gets spawned.

Drop a .pgls.json at the workspace root pointing at your DDL:

{ "schemaDir": "db/schema" }

See the pgls README for the full set of fields (schemaDir, sqlFunctions, etc.). The file is pgls's authoritative config — committing it to the repo gives every contributor the same behaviour across every editor (VSCode, Vim, Neovim, Helix, plain CLI).

Settings

Try it

A complete demo workspace lives at winebarrel/pgls-example — clone, open in VSCode with this extension installed, and the SQL strings in main.go and example.sql should light up immediately.

License

MIT