Skip to content

Latest commit

 

History

History
99 lines (50 loc) · 1.9 KB

cli.md

File metadata and controls

99 lines (50 loc) · 1.9 KB

Command-Line Help for sqruff

This document contains the help content for the sqruff command-line program.

Command Overview:

sqruff

sqruff is a sql formatter and linter

Usage: sqruff [OPTIONS] <COMMAND>

Subcommands:
  • lint — Lint SQL files via passing a list of files or using stdin
  • fix — Fix SQL files via passing a list of files or using stdin
  • lsp — Run an LSP server
  • info — Print information about sqruff and the current environment
Options:

  • --config <CONFIG> — Path to a configuration file

  • --parsing-errors — Show parse errors

    Default value: false

sqruff lint

Lint SQL files via passing a list of files or using stdin

Usage: sqruff lint [OPTIONS] [PATHS]...

Arguments:
  • <PATHS> — Files or directories to fix. Use - to read from stdin
Options:

  • -f, --format <FORMAT>

    Default value: human

    Possible values: human, github-annotation-native, json

sqruff fix

Fix SQL files via passing a list of files or using stdin

Usage: sqruff fix [OPTIONS] [PATHS]...

Arguments:
  • <PATHS> — Files or directories to fix. Use - to read from stdin
Options:

  • --force — Skip the confirmation prompt and go straight to applying fixes

  • -f, --format <FORMAT>

    Default value: human

    Possible values: human, github-annotation-native, json

sqruff lsp

Run an LSP server

Usage: sqruff lsp

sqruff info

Print information about sqruff and the current environment

Usage: sqruff info

This document was generated automatically by clap-markdown.