Slikr

A fork of Sleek with added configuration file support. Slikr automatically looks for a config file (.slikr.json), and falls back to default settings if no config file or options/flags are provided.

Features

• Format SQL files using customisable indentation and character case options
• Supports glob patterns, allowing you to format multiple files and patterns
• Check whether your SQL files are already formatted without altering them with the --check flag
• Uppercase keywords by default (disable with --uppercase false)
• Automatically adds trailing newlines to formatted output (disable with --trailing-newline false)
• New: Read from a specific JSON config file with -C, --config <PATH>
• Searches for default config file .slikr.json in current working directory and home directory if not explicitly provided

Installation

Download Compiled Binaries

You can download the compiled binaries for Slikr from the Releases page. Choose the binary that corresponds to your operating system and architecture, and place it in a directory included in your system's PATH.

Install with Cargo

To install Slikr using Cargo, you need Rust installed on your system. Once Rust is installed:

cargo install slikr

Usage

slikr [OPTIONS] [FILE]...

Arguments

• [FILE]...: File path(s) to format, supports glob patterns. If no file paths are provided, reads from stdin or falls back to defaults.

Options

Examples

Note: Boolean flags require explicit values. Both formats work:

# Space format
slikr --uppercase true

# Equals format
slikr --uppercase=true

Format a query from stdin:

echo "select * from users" | slikr --uppercase true

Check if a query is formatted correctly from stdin:

echo "select * from users" | slikr --check

Format a single file using default options if no config file is found:

slikr my_query.sql

Format multiple files using a glob pattern:

slikr "queries/*.sql"

Format files with custom options:

slikr --indent-spaces 2 --uppercase false "queries/*.sql"

Format files with a specific config file:

slikr --config /path/to/myconfig.json "queries/*.sql"
# or
slikr -C /path/to/myconfig.json "queries/*.sql"

Check if files are already formatted:

slikr --check "queries/*.sql"

Format files without trailing newlines:

slikr --trailing-newline false "queries/*.sql"

Original Project

This is a fork of Sleek — for the original CLI, VS Code extension, and full documentation, see their repository.