Theme Check commands

If you run Theme Check through the command line, then you can use the following commands and flags to call and run Theme Check. These commands can be run using Shopify CLI. Learn more about the checks that Theme Check runs.

Use this command if you're linting theme code:

Use this command if you're linting theme app extension code:

Parameter Short version Description
--config <PATH> -C <PATH> The path to your custom Theme Check config. This config overrides .theme-check.yml, if it is present in the directory being analyzed.
--category <CATEGORY> -c <CATEGORY> Runs only the specified category of checks. You can specify multiple categories using multiple instances of this flag.
--exclude-category <CATEGORY> -x <CATEGORY> Runs all checks other than those in the specified category. You can specify multiple categories using multiple instances of this flag.
--fail-level <LEVEL> The severity level that causes a run of theme check to fail (exit code 1). Options include error, suggestion, and style.
--auto-correct -a Automatically fixes correctable offenses.
--init Generates a new Theme Check config file.
--output -o Outputs the results of the check to a file. Options include json and text (default).
--print Outputs the active config to STDOUT.
--list -l Lists the active checks.
--version -v Prints the version of Theme Check being used.