CLI Reference

Use tq through a subcommand-first CLI with a strict contract surface.

Distribution and invocation

Published PyPI distribution: tqlint.

Installed command: tq.

For install and setup, see Quickstart.

Command model

Primary command:

• tq check

This command surface is designed for:

• deterministic diagnostics
• explicit rule-selection controls
• machine-readable reporting for CI tooling

tq check options

The table below documents command options.

Flags	Config key	Default	Description
--config	—	none	Use this pyproject file instead of discovered configuration.
--isolated	—	false	Ignore discovered configuration files.
--target	—	[]	Run only listed target names.
--init-modules	init_modules	none	How mapping checks handle init.py modules.
--max-test-file-non-blank-lines	max_test_file_non_blank_lines	none	Maximum non-blank, non-comment lines per test file.
--qualifier-strategy	qualifier_strategy	none	Module-name qualifier policy for qualified test files.
--allowed-qualifier	allowed_qualifiers	[]	Allowed qualifier suffix for allowlist strategy.
--select	select	[]	Only run selected rule IDs.
--ignore	ignore	[]	Skip listed rule IDs.
--output-format	—	text	Select output format.
--show-suggestions	—	false	Render remediation suggestions in diagnostics output.
--exit-zero	—	false	Always exit with code 0 regardless of findings.

Run tq check --help for the runtime source of truth.

Output formats

tq check supports:

• text (default): concise terminal diagnostics
• json: machine-readable diagnostics payload

Use:

tq check --output-format json

JSON findings include stable fields:

• rule_id
• severity
• message
• path
• line
• suggestion
• target

JSON summary includes:

• errors
• warnings
• infos
• total

Language support

tq currently targets Python codebases.