.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "FOODCRITIC" "1" "July 2018" "" ""
.
.SH "NAME"
\fBfoodcritic\fR \- lint tool for chef cookbooks
.
.SH "SYNOPSIS"
\fBfoodcritic\fR [\fIoptions\fR\.\.\.] \fIcookbook\fR\.\.\.
.
.P
\fBfoodcritic\fR [\fIoptions\fR\.\.\.] \-\-list
.
.SH "DESCRIPTION"
\fBfoodcritic\fR makes it easier to flag problems in your Chef cookbooks that will cause Chef to blow up when you attempt to converge\. This is about faster feedback\.
.
.P
Each \fBcookbook\fR path specified will be examined for common problems and poor style\.
.
.SH "OPTIONS"
.
.TP
\fB\-t\fR, \fB\-\-tags\fR \fITAGS\fR
Only check against rules with the specified tags\. Prefix tags with a tilde \fB~\fR to exclude rules\.
.
.TP
\fB\-l\fR, \fB\-\-list\fR
Do not perform a lint check; instead simply list the rules that would be enabled based on the defaults and the rule selection options (\-t, \-I)
.
.TP
\fB\-f\fR, \fB\-\-epic\-fail\fR \fITAGS\fR
Exit non\-zero if any of the specified tags are matched\. Use the pseudo\-tag \fBany\fR to fail if any tag is matched\.
.
.TP
\fB\-c\fR, \fB\-\-chef\-version\fR \fIVERSION\fR
Only check against rules valid for this version of Chef\.
.
.TP
\fB\-B\fR, \fB\-\-cookbook\-path\fR
Cookbook path(s) to check\.
.
.TP
\fB\-C\fR, \fB\-\-\fR[\fBno\-\fR]\fBcontext\fR
Show lines matched against rather than the default summary\.
.
.TP
\fB\-E\fR, \fB\-\-environment\-path\fR
Environment path(s) to check\.
.
.TP
\fB\-I\fR, \fB\-\-include\fR \fIPATH\fR
Additional rule file path(s) to load\.
.
.TP
\fB\-R\fR, \fB\-\-role\-path\fR
Role path(s) to check\.
.
.TP
\fB\-S\fR, \fB\-\-search\-grammar\fR \fIPATH\fR
Specify grammar to use when validating search syntax\. (Default: the grammar of any installed Chef)
.
.TP
\fB\-V\fR, \fB\-\-version\fR
Display the foodcritic version\.
.
.TP
\fB\-X\fR, \fB\-\-exclude\fR \fIPATH\fR
Exclude path(s) from being linted\.
.
.SH "RETURN VALUES"
By default, \fBfoodcritic\fR will always return \fB0\fR\.
.
.P
If \fB\-\-epic\-fail\fR is specified, then \fBfoodcritic\fR will return \fB3\fR if any tags are matched\.
.
.SH "COPYRIGHT"
\fBfoodcritic\fR is Copyright 2011 by Andrew Crump\.
.
.SH "SEE ALSO"
chef(1)