DocsCliInstall

quell install

Install a GitHub Action workflow or pre-commit hook for your project.

Usage

quell install github-action   # Add .github/workflows/quell.yml
quell install pre-commit      # Add quell to .pre-commit-config.yaml

GitHub Action

quell install github-action

Creates .github/workflows/quell.yml:

name: Quell edge case check

on: [push, pull_request]

jobs:
  quell:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-python@v5
        with:
          python-version: "3.11"
      - run: pip install quelltest
      - run: quell ci src/ --threshold 75

See GitHub Actions guide for customization options.

Pre-commit hook

quell install pre-commit

Adds to .pre-commit-config.yaml:

repos:
  - repo: https://github.com/shashank7109/quell
    rev: v1.0.0
    hooks:
      - id: quell-check
        args: ["--threshold", "75"]

Then install hooks:

pre-commit install