Get Started

Hallux is a python CLI tool which can be installed with pip. Latest version can be found here: https://pypi.org/project/hallux/ (opens in a new tab)

Prerequisites

pip install hallux

Create the following .hallux config file under the root directory

.hallux

backends:
  - gpt3:
    type: openai
    model: gpt-3.5-turbo
    max_tokens: 4096
 
tools:
  # only for python projects
  ruff: .
 
target: files

💡

More configuration options for the docs theme can be found here.

export OPENAI_API_KEY=xxx
export SONAR_TOKEN=xxx

hallux --ruff --gpt3 .