rigsql

Fast SQL linter written in Rust. sqlfluff-compatible rule codes with AI-friendly JSON output.

Features

• Custom CST (Concrete Syntax Tree) parser — preserves all whitespace and comments
• Error recovery — produces partial CSTs even for invalid SQL
• sqlfluff-compatible rule code system (CP01, LT01, AL01, etc.)
• 75 rules across 9 categories: Capitalisation, Layout, Convention, Aliasing, Ambiguous, References, Structure, TSQL, Rigsql
• AI-friendly JSON output with rule explanations, context, and source lines
• Multi-dialect support: ANSI, PostgreSQL, SQL Server (TSQL)
• i18n support — violation messages in English and Japanese (--locale en|ja)
• Auto-fix for many rules (rigsql fix)
• Parallel file processing via rayon
• Configuration via rigsql.toml or .sqlfluff (compatible)
• Inline -- noqa comments to suppress violations
• Recursive directory scanning with .gitignore support
• Shell completions for bash, zsh, fish, elvish, powershell
• GitHub Action for CI integration
• Multiple output formats: human, JSON, SARIF, GitHub Annotations

Installation

From crates.io:

cargo install rigsql-cli

From source:

cargo install --path crates/rigsql-cli

Quick Start

# Lint a single file
rigsql lint query.sql

# Lint a directory recursively
rigsql lint ./queries/

# Lint with SQL Server dialect
rigsql lint ./queries/ --dialect tsql

# Lint with Japanese violation messages
rigsql lint ./queries/ --locale ja

# Auto-fix violations
rigsql fix ./queries/

# JSON output (for CI/AI tools)
rigsql lint ./queries/ --format json

# SARIF output (for IDE integration)
rigsql lint ./queries/ --format sarif

# GitHub Annotations (for CI)
rigsql lint ./queries/ --format github

# View the CST of a SQL file
rigsql parse query.sql

# Generate shell completions
rigsql completions zsh > _rigsql

Usage

rigsql <COMMAND>

Commands:
  lint         Lint SQL files for style violations
  fix          Auto-fix SQL files
  parse        Parse SQL files and display the Concrete Syntax Tree
  rules        List available lint rules
  completions  Generate shell completions

rigsql lint

rigsql lint [OPTIONS] [FILES]...

Arguments:
  [FILES]...  SQL files or directories to lint

Options:
  --dialect <DIALECT>  SQL dialect [default: ansi] [possible values: ansi, postgres, tsql]
  --locale <LOCALE>    Output locale (e.g. "en", "ja") — overrides config and system locale
  --format <FORMAT>    Output format [default: human] [possible values: human, json, sarif, github]
  --no-color           Disable colored output

rigsql fix

rigsql fix [OPTIONS] [FILES]...

Arguments:
  [FILES]...  SQL files or directories to fix

Options:
  --dialect <DIALECT>  SQL dialect [default: ansi] [possible values: ansi, postgres, tsql]
  --locale <LOCALE>    Output locale (e.g. "en", "ja") — overrides config and system locale
  --dry-run            Don't write changes, just show what would be fixed
  -f, --force          Skip confirmation prompt

rigsql parse

rigsql parse [OPTIONS] <FILE>

Arguments:
  <FILE>  SQL file to parse (use - for stdin)

Options:
  --dialect <DIALECT>  SQL dialect [default: ansi] [possible values: ansi, postgres, tsql]
  --format <FORMAT>    Output format [default: tree] [possible values: tree, json]

rigsql completions

rigsql completions <SHELL>

Arguments:
  <SHELL>  Shell to generate completions for [possible values: bash, elvish, fish, powershell, zsh]

Rules

75 rules across 9 categories, compatible with sqlfluff rule codes.

Capitalisation (CP)

Layout (LT)

Convention (CV)

Aliasing (AL)

Ambiguous (AM)

References (RF)

Structure (ST)

TSQL (TQ)

Rigsql (RG)

Configuration

rigsql looks for configuration in the following order (closest to the file wins):

1. rigsql.toml (preferred)
2. .sqlfluff (compatible fallback)

rigsql.toml

[core]
dialect = "tsql"
max_line_length = 120
exclude_rules = ["LT09", "CV06"]

[rules."capitalisation.keywords"]
capitalisation_policy = "lower"

[rules."capitalisation.identifiers"]
capitalisation_policy = "consistent"

.sqlfluff

[sqlfluff]
dialect = tsql
max_line_length = 120
exclude_rules = LT09,CV06

[sqlfluff:rules:capitalisation.keywords]
capitalisation_policy = lower

Inline noqa

SELECT
    col1,  -- noqa: CP01
    col2
FROM my_table;  -- noqa

Output Examples

Human (default)

query.sql
  L   1:1   | CP01 | Keywords must be upper case. Found 'select' instead of 'SELECT'.
  L   2:1   | CP01 | Keywords must be upper case. Found 'from' instead of 'FROM'.
  L   2:6   | AL01 | Implicit aliasing not allowed. Use explicit AS keyword.
  L   7:13  | LT01 | Expected single space, found 2 spaces.
  L   8:1   | CV06 | Statement is not terminated with a semicolon.

Found 5 violation(s) in 1 file(s) (1 file(s) scanned).

JSON (--format json)

{
  "version": "1.0",
  "tool": {
    "name": "rigsql",
    "version": "0.7.0"
  },
  "summary": {
    "files_scanned": 1,
    "files_with_violations": 1,
    "total_violations": 5,
    "by_rule": { "CP01": 2, "AL01": 1, "LT01": 1, "CV06": 1 }
  },
  "files": [
    {
      "path": "query.sql",
      "violations": [
        {
          "rule": {
            "code": "CP01",
            "name": "capitalisation.keywords",
            "description": "Keywords must be consistently capitalised.",
            "explanation": "SQL keywords like SELECT, FROM, WHERE should use consistent capitalisation..."
          },
          "message": "Keywords must be upper case. Found 'select' instead of 'SELECT'.",
          "severity": "warning",
          "location": { "line": 1, "column": 1 },
          "context": { "source_line": "select u.id, u.Name, count(*) cnt" }
        }
      ]
    }
  ]
}

GitHub Action

- uses: yukonsky/rigsql@v0.7.0
  with:
    paths: "./queries/"
    dialect: "ansi"
    format: "github"

Exit Codes

Project Structure

crates/
  rigsql-core/      # Token, Span, Segment types, tree traversal
  rigsql-lexer/     # Multi-dialect tokenizer
  rigsql-parser/    # Grammar combinators + CST builder
  rigsql-dialects/  # ANSI, PostgreSQL, TSQL dialect definitions
  rigsql-rules/     # All lint rules (CP, LT, CV, AL, AM, RF, ST, TQ, RG)
  rigsql-config/    # Configuration loading (.sqlfluff, rigsql.toml)
  rigsql-output/    # Human, JSON, SARIF, GitHub Annotation formatters
  rigsql-i18n/      # Internationalization (en, ja locale files)
  rigsql-cli/       # CLI binary

License

MIT