diff --git a/docs/CLI.md b/docs/CLI.md new file mode 100644 index 000000000..237507f3f --- /dev/null +++ b/docs/CLI.md @@ -0,0 +1,109 @@ +[Back to overview](./README.md) + +# wp plugin check + +Runs plugin check. + +## OPTIONS +``` + +: The plugin to check. Plugin name. + +[--checks=] +: Only runs checks provided as an argument in comma-separated values, e.g. i18n_usage, late_escaping. Otherwise runs all checks. + +[--exclude-checks=] +: Exclude checks provided as an argument in comma-separated values, e.g. i18n_usage, late_escaping. +Applies after evaluating `--checks`. + +[--format=] +: Format to display the results. Options are table, csv, and json. The default will be a table. +--- +default: table +options: + - table + - csv + - json +--- + +[--categories] +: Limit displayed results to include only specific categories Checks. + +[--fields=] +: Limit displayed results to a subset of fields provided. + +[--ignore-warnings] +: Limit displayed results to exclude warnings. + +[--ignore-errors] +: Limit displayed results to exclude errors. + +[--include-experimental] +: Include experimental checks. + +[--exclude-directories=] +: Additional directories to exclude from checks +By default, `.git`, `vendor` and `node_modules` directories are excluded. +``` +## EXAMPLES +``` +wp plugin check akismet +wp plugin check akismet --checks=late_escaping +wp plugin check akismet --format=json +``` + +# wp plugin list-checks + +Lists the available checks for plugins. + +## OPTIONS +``` +[--fields=] +: Limit displayed results to a subset of fields provided. + +[--format=] +: Format to display the results. Options are table, csv, and json. The default will be a table. +--- +default: table +options: + - table + - csv + - json +--- + +[--categories] +: Limit displayed results to include only specific categories. + +[--include-experimental] +: Include experimental checks. +``` +## EXAMPLES +``` +wp plugin list-checks +wp plugin list-checks --format=json +``` + +# wp plugin list-check-categories + +Lists the available check categories for plugins. + +## OPTIONS +``` +[--fields=] +: Limit displayed results to a subset of fields provided. + +[--format=] +: Format to display the results. Options are table, csv, and json. The default will be a table. +--- +default: table +options: + - table + - csv + - json +--- +``` +## EXAMPLES +``` +wp plugin list-check-categories +wp plugin list-check-categories --format=json +``` \ No newline at end of file diff --git a/docs/README.md b/docs/README.md index 0a1c25457..f0ffa57b7 100644 --- a/docs/README.md +++ b/docs/README.md @@ -3,3 +3,4 @@ * [Technical Overview](technical-overview.md) * [Creating a Static Check](creating-a-static-check.md) * [Creating a Runtime Check](creating-a-runtime-check.md) +* [CLI Commands](CLI.md)