Lint PostgreSQL migrations and SQL changes before irreversible schema mistakes land with Squawk

Catch locking, indexing, and schema-change hazards in PostgreSQL migration SQL before a review turns into downtime.

Prerequisites

Squawk CLI or container image, PostgreSQL migration SQL files, and optional CI or pre-commit integration.

Installation

Use the upstream install or setup path that matches your environment:

• npm install -g squawk-cli
• pip install squawk-cli
• docker run --rm -v $(pwd):/data ghcr.io/sbdchd/squawk:latest *.sql
• cargo install

Requirements and caveats from upstream:

• Or via Docker

• You can also run Squawk using Docker. The official image is available on GitHub Container Registry.
• warning[prefer-text-field]: Changing the size of a varchar field requires an ACCESS EXCLUSIVE lock, that will prevent all reads and writes to the table.

Basic usage or getting-started notes:

• Quick Start | Playground | Rules Documentation | GitHub Action | [DIY GitHub Int...

• shell

• or via PYPI

• Source: https://github.com/sbdchd/squawk

• Extracted from upstream docs: https://raw.githubusercontent.com/sbdchd/squawk/HEAD/README.md

Documentation

• https://squawkhq.com

Source

• Agent Skill Exchange