Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.qlty.sh/llms.txt

Use this file to discover all available pages before exploring further.

Most Qlty users user Qlty Cloud, our fully automated Code Health Platform, to run static analysis in the cloud, making CI setup unnecessary. However, there are a few use cases where running Qlty CLI in your continuous integration (CI) pipeline is useful.

​
Auto-formatting your code nightly

Qlty Cloud does not currently support auto-formatting your code. However, you can run qlty fmt in your CI pipeline to automatically format your code nightly. Here is an example GitHub Actions workflow:
.github/workflows/fmt.yml
name: fmt

on:
    workflow_dispatch:
    schedule:
        - cron: "0 6 * * *"

permissions:
    contents: write

jobs:
    format:
        runs-on: ubuntu-latest
        steps:
            - uses: actions/checkout@v4
              with:
                  ref: ${{ github.head_ref }}

            - uses: qltysh/qlty-action/fmt@main

            - name: Commit changes
              uses: stefanzweifel/git-auto-commit-action@v5
              with:
                  commit_message: qlty fmt --all
                  branch: ${{ github.head_ref }}
                  commit_user_name: qltysh[bot]
                  commit_user_email: 168846912+qltysh[bot]@users.noreply.github.com
                  commit_author: qltysh[bot] <168846912+qltysh[bot]@users.noreply.github.com>

​
Publishing code coverage data to Qlty Cloud

Qlty CLI is used to publish code coverage data to Qlty Cloud. Please see our documentation for setting up code coverage for more information.