Format

Format SQL files using the syntaqlite formatter. Use when the user wants to format, reformat, or pretty-print SQL code.

lalitmaganti Updated
The syntaqlite playground: a query with a typo in a column name, its formatted output, and the error "unknown column 'nme'" with the suggestion "did you mean 'n

File contents

Format SQL

Format SQLite SQL using the syntaqlite CLI formatter.

Usage

# Format a file (print to stdout)
syntaqlite fmt query.sql

# Format in-place
syntaqlite fmt -i query.sql

# Format from stdin
echo "SELECT a,b FROM t WHERE x=1" | syntaqlite fmt

# Format multiple files via glob
syntaqlite fmt -i "**/*.sql"

# Format with options
syntaqlite fmt -w 120 -k upper query.sql

Options

  • -e, --expression <SQL>: format an inline SQL expression instead of files
  • -w, --line-width <N>: max line width (default: 80)
  • -t, --indent-width <N>: spaces per indentation level (default: 2)
  • -k, --keyword-case <upper|lower>: keyword casing (default: upper)
  • -i, --in-place: overwrite files in place
  • --check: check if files are formatted (exit 1 if not)
  • --semicolons <true|false>: append semicolons (default: true)

Notes

  • When the user asks to format a specific file, use -i to write in place.
  • When formatting multiple files, use a glob pattern with -i.
  • Use --check in CI to verify formatting without modifying files.

lalitmaganti/syntaqlite commit 446efded20

Frequently asked questions

npx get-skill add lalitmaganti/format