macOS
Homebrewverified · 100%
brew install sql-formatterlocal Homebrew formula metadata
brew
Install sql-formatter with Homebrew, Nix
Whitespace formatter for different query languages. Version 15.8.2 via Homebrew; verified 2026-06-22.
install
Additional install commands
Linux
Nixverified · 92%
nix profile install nixpkgs#sql-formatternixpkgs package indexes · pkgs/by-name/sq/sql-formatter/package.nix · source: api.github.com
overview
Package summary
Whitespace formatter for different query languages
Project links
Commands and aliases
- sql-formatter
history
Project history and usage
SQL Formatter is a TypeScript and JavaScript library and CLI for pretty-printing SQL and related query languages.
Project history
The project was created in 2016 and its README says it started as a port of a PHP library before diverging substantially. It grew into a multi-dialect formatter supporting engines and query languages including BigQuery, ClickHouse, DB2, DuckDB, Hive, MariaDB, MySQL, N1QL, Oracle PL/SQL, PostgreSQL, Redshift, Snowflake, Spark, SQLite, Transact-SQL, Trino, and others.
Adoption history
SQL Formatter is primarily distributed through the JavaScript package ecosystem, with the README recommending npm, yarn, pnpm, or bun. The supplied package metadata also shows Homebrew and Nix packaging for the CLI, and the organization maintains an official VS Code extension.
How it is used
The library exposes a `format` function for applications, while the CLI installs as `sql-formatter` and can format stdin or a file. It accepts language and config options, searches for `.sql-formatter.json` in the current or parent directories, and can also use a config path or JSON string passed with `--config`.
Why package nerds care
Package nerds care about SQL Formatter because it is a small, installable formatting primitive that can be embedded in editors, scripts, CI, and language tooling. Its appeal is broad dialect coverage and simple package-manager installation rather than a full SQL linting framework.
Timeline
- 2016: GitHub repository created and v0.0.1 published.
- 2026: v15.8.2 published on GitHub releases.
Related projects
- The README credits the original PHP sql-formatter library as its starting point and links to official editor integrations, including the SQL Formatter VS Code extension.
Sources
- GitHub API repository and releases metadata for sql-formatter-org/sql-formatter, accessed 2026-07-02
- https://github.com/sql-formatter-org/sql-formatter
- https://raw.githubusercontent.com/sql-formatter-org/sql-formatter/master/package.json
- https://sql-formatter-org.github.io/sql-formatter/
- input source_facts.package-manager
security posture
No protected-tool coverage found yet
No matching local secret-handling manifest was found for sql-formatter. Nucleus package metadata is still published here so future coverage has a stable package URL.
Install behavior
- No Homebrew post-install hook is recorded in formula metadata.
- Homebrew bottle metadata is available for 1 platform targets.
- Installs with 1 runtime dependencies.
Recommended review
Before unattended agent use, check whether the tool reads plaintext credentials, writes remote state, publishes artifacts, or shells out to plugins.
local files
Configuration and credential file locations
These source-backed paths show where this package keeps local settings or durable credentials. Automic Vault can use them as review targets for secret scanning, migration, and command approval.
Configuration files
Config paths the tool may read or write during local use.
- Unix
.sql-formatter.json
executables
Installed executables
| Command | Kind | Exposure | Note |
|---|---|---|---|
sql-formatter | cli | global executable |
freshness
Version and freshness
These signals separate page generation age, package-manager activity, and upstream release comparison. Version lag is warned only when an evidence URL and comparable versions are present.
page generated2026-07-08
manager version15.8.2
manager updated2026-06-22
local dataok
upstreamnot checked
latest detectednot detected
https://sql-formatter-org.github.io/sql-formatter/
- infoRelease/tag comparison is only available for GitHub repositories.https://sql-formatter-org.github.io/sql-formatter/none confidence
install metadata
Package metadata
| Package key | brew:sql-formatter |
|---|---|
| Version | 15.8.2 |
| Package manager | Homebrew |
| Package manager page | https://formulae.brew.sh/formula/sql-formatter |
| Homepage | https://sql-formatter-org.github.io/sql-formatter/ |
| Repository | https://github.com/sql-formatter-org/sql-formatter |
| Upstream docs | https://github.com/sql-formatter-org/sql-formatter#readme |
| License | MIT |
| Source archive | https://registry.npmjs.org/sql-formatter/-/sql-formatter-15.8.2.tgz |
| Last updated | 2026-06-22T14:17:23Z |
| Pulse | updated |
| Dependencies | node |
| Bottle | available (on all) |
| Homebrew post-install | not defined |
| Service | none declared |
registry facts
Source database details
| Source Database | Homebrew formula API |
|---|---|
| Tap | homebrew/core |
| Full Name | sql-formatter |
| Version Scheme | 0 |
| Revision | 0 |
| Bottle Stable Root URL | https://ghcr.io/v2/homebrew/core |
| Deprecated | no |
| Disabled | no |
| Keg Only | no |
| URL Keys |
|
source database matches
Other package-manager records
Matches are pulled from external package-manager indexes and kept separate from local Automic Vault package links.
Nix95%
sql-formatter
nix profile install nixpkgs#sql-formatter- normalized package name match
- Matched by: Sql Formatter
source trail
Generated from repository data
This page is generated by av-web from the private package SQLite artifact built by scripts/generate-pkg-sqlite.py.
Combined YAML source
View the package source record on GitHub.
Used sources
- Geiger risk classifier
- Nucleus package database
- av.db category and tag curation
- cross-ecosystem install command graph
- curated configuration and credential file locations
- curated package history
- external package-manager database matches
- package relationship graph
- package version freshness
- package-page enrichment