rules

Synopsis

gapline rules list [--severity LEVEL] [--format FORMAT] [-o PATH]

Description

rules list enumerates every validation rule compiled into the current gapline build. Use it to find a rule ID for --disable-rule, audit which rules apply at each severity, or export the catalogue for a compliance report.

Sub-commands

Command	Purpose
list	Print the registered rules.

Options (rules list)

Flag	Short	Value	Description
--severity		LEVEL	Restrict the listing to rules of this severity: error, warning, or info.
--format		FORMAT	Output format: text, json, csv, xml, html. Defaults to text.
--output	-o	PATH	Write the listing to this path instead of stdout.

Global flags are listed on reference/global-flags.

Examples

List every rule

gapline rules list

Only the errors

gapline rules list --severity error

Export the full catalogue as JSON

gapline rules list --format json -o rules.json

The JSON object is suitable for diffing across releases or generating an internal compliance report.

Find a rule to disable

gapline rules list | grep -i speed

Feed the matching ID to --disable-rule:

gapline validate -f gtfs.zip --disable-rule speed_validation

Exit codes

Code	Meaning
0	Listing produced successfully.
2	Configuration error.
3	I/O error (output path unwritable).

See concepts/exit-codes for the complete table.

See also

• Validation rules catalogue — searchable reference for every rule.
• gapline validate — run the rules against a feed.
• Concepts / Severities — how error, warning, and info differ.