Skip to content

Python CLI overview

The quell command from the PyPI package has one primary command, quell find, and a set of utilities for scoring, CI, setup, pull requests, graph inspection, authentication and cloud sync. This page lists them as printed by quell --help in the repository at version 2.0.1. For the npm package's quell command, see the npm CLI reference.

What are the commands?

CommandPurposeDetails
quell find [TARGET]Find untested edge cases. --fix writes tests for confident cases.quell find
quell score [TARGET]Show the Production Readiness Score. --badge prints an SVG, --json prints JSON.quell score
quell reproduce "<bug>"Convert a bug description into a verified failing test.quell reproduce
quell prove FILEShow the share of requirements proven for a file or function (--function).below
quell ci [TARGET]CI mode: exit 1 when the score is below --threshold.quell ci
quell initAdd a [tool.quell] block to pyproject.toml.quell init
quell installSet up a pre-commit hook and a GitHub Actions workflow.quell install
quell pr PR_NUMBERAnalyze requirement coverage for a GitHub pull request (--comment, --fix, --repo, --token, --format json). Reads GITHUB_TOKEN.below
quell authManage credentials: login, logout, set, status.quell auth
quell mcpRun the local MCP server on stdio.MCP server
quell graphQuellGraph subcommands: build, show, why, stale, stats.below
quell syncCloud sync (Pro and Team): push, status, history, unlink.Connector
quell teardownStop and remove quelltest-managed ephemeral containers.below

Global option: --version / -V prints quelltest <version>.

Which commands are deprecated?

quell scan and quell check still exist but print a deprecation notice: use quell find. They will be removed in v2.2.

What do the smaller commands do?

  • quell prove src/payments.py --function process_payment prints the percentage of requirements proven for that file or function.
  • quell pr 42 --comment analyzes pull request 42 (repository detected from the git remote unless --repo owner/repo) and can post the result as a comment. Set GITHUB_TOKEN or pass --token; the token needs the repo and pull request scopes.
  • quell graph build src/ builds or incrementally updates a code-intelligence index at .quellgraph/graph.db; graph show, graph why FUNCTION, graph stale and graph stats inspect it.
  • quell teardown stops containers that quelltest started for verification (tracked in .quellgraph/containers.lock).

Most commands accept --root PATH (default .) for the project root.

Which exit codes do they use?

quell ci exits 1 below the threshold; quell find exits 0 whether or not gaps were found. Commands that fail on missing input or configuration exit 1. Details are on each command page.