Interactive GUI tool for visually creating and managing SQLFluff configuration. Built with Python + PySide6 (Qt).
- Visual configurator – all parameters organized in categories with descriptions
- Live preview – see the generated
.sqlflufffile instantly - Sample SQL – apply configuration to a sample SQL query and see changes
- Rules – configure all linting rules
- Layout – set spacing and line-breaking for each element type
- Indentation – spaces/tabs, JOIN/CASE/CTE indentation, etc.
- Export – save configuration as
.sqlfluff,setup.cfgsection, orpyproject.toml - Presets – save and load entire configuration profiles
pip install sqlfluff-uiOr from the repository:
git clone https://github.com/yourusername/sqlfluff-ui.git
cd sqlfluff-ui
pip install -e .Coming soon.
# Launch GUI
sqlfluff-ui
# Or as a Python module
python -m sqlfluff_ui# Environment
python -m venv .venv
source .venv/bin/activate
# Install including dev dependencies
pip install -e ".[dev]"
# Run
python -m sqlfluff_uisqlfluff-ui/
├── src/sqlfluff_ui/
│ ├── config/ # Data model and logic
│ │ ├── model.py # ConfigOption, ConfigSection dataclasses
│ │ ├── loader.py # Loading config info from sqlfluff
│ │ └── generator.py # Generating .sqlfluff output
│ ├── ui/ # Qt widgets
│ │ ├── main_window.py
│ │ ├── core_panel.py
│ │ ├── indentation_panel.py
│ │ ├── layout_panel.py
│ │ ├── rules_panel.py
│ │ ├── preview_panel.py
│ │ └── sample_panel.py
│ ├── app.py
│ └── __main__.py
├── tests/
├── pyproject.toml
└── README.md
MIT