# quell install

> quell install adds a pre-commit hook and a GitHub Actions workflow that comments the Production Readiness Score on pull requests. Flags --hook and --pr.

Canonical page: https://quelltest.com/docs/cli/install

`quell install` sets up quelltest in a Python repository: a pre-commit hook, a GitHub Actions workflow for pull requests, or both. Run it once per repository and commit the files it creates.

## What is the syntax?

```bash
quell install          # pre-commit hook and GitHub Action
quell install --hook   # pre-commit hook only
quell install --pr     # GitHub Actions workflow only
```

Both parts skip themselves if they already exist. `--root PATH` selects the project root.

## What does the pre-commit hook do?

It creates or extends `.pre-commit-config.yaml` with a local hook that runs `quell check --diff-only --no-llm --auto` on commit (the deprecated `check` entry point, restricted to changed files, rule-based only):

```yaml
repos:
  - repo: local
    hooks:
      - id: quell
        name: Quell — verify requirements
        entry: quell check --diff-only --no-llm --auto
        language: system
        types: [python]
        pass_filenames: false
```

Then run `pre-commit install` yourself to activate it.

## What does the GitHub Action do?

It writes `.github/workflows/quell.yml`, which runs on pull requests that touch `**.py` with `contents: read` and `pull-requests: write` permissions. The job installs quelltest with `uv`, runs `quell find . --format github` (inline annotations for untested guards), reads `quell-report.json`, and posts or updates a single pull-request comment with the Production Readiness Score. The command prints a reminder to add a `QUELL_API_KEY` repository secret and to commit the workflow.

To write a workflow by hand instead, see the [GitHub Actions guide](https://quelltest.com/docs/guides/github-actions.md). Using JavaScript or TypeScript? See the [npm CI guide](https://quelltest.com/docs/npm/ci.md).
