'\" t
.\" Title: ansible-lint
.\" Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.79.1
.\" Date: 08/12/2017
.\" Manual: System administration commands
.\" Source: ansible-lint
.\" Language: English
.\"
.TH "ANSIBLE\-LINT" "1" "08/12/2017" "ansible\-lint" "System administration commands"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
ansible-lint \- lint tool for Ansible playbooks
.SH "SYNOPSIS"
.sp
ansible\-lint [\-M module_path] [\-l] [\-s] [module\&...]
.SH "DESCRIPTION"
.sp
\fBansible\-lint\fR checks Ansible playbooks for practices and behaviour that could potentially be improved\&.
.SH "OPTIONS"
.sp
\fB\-\-version\fR:
.sp
show program\(cqs version number and exit
.PP
\fB\-M\fR \fIDIRECTORY\fR, \fB\-\-module\-path=\fR\fIDIRECTORY\fR
.RS 4
the
\fIDIRECTORY\fR
search path to load modules from\&. The default is
\fI/usr/share/ansible\fR\&. This can also be set with the ANSIBLE_LIBRARY environment variable\&.
.RE
.PP
\fB\-s\fR, \fB\-\-snippet=\fR
.RS 4
Produce a snippet which can be copied into a playbook for modification, like a kind of task template\&.
.RE
.PP
\fB\-l\fR, \fB\-\-list=\fR
.RS 4
Produce a terse listing of modules and a short description of each\&.
.RE
.PP
\fB\-h\fR, \fB\-\-help\fR
.RS 4
show this help message and exit
.RE
.PP
\fB\-L\fR
.RS 4
list all the rules
.RE
.PP
\fB\-q\fR
.RS 4
quieter, although not silent output
.RE
.PP
\fB\-p\fR
.RS 4
parseable output in the format of pep8
.RE
.PP
\fB\-r\fR \fIRULESDIR\fR
.RS 4
specify one or more rules directories using one or more
\fB\-r\fR
arguments\&. Any
\fB\-r\fR
flags override the default rules in
\fI/usr/lib/python3/dist\-packages/ansiblelint/rules\fR,
unless
\fB\-R\fR
is also used\&.
.RE
.PP
\fB\-R\fR
.RS 4
Use default rules in
\fI/usr/lib/python3/dist\-packages/ansiblelint/rules\fR
in addition to any extra rules directories specified with
\fB\-r\fR\&. There is no need to specify this if no
\fB\-r\fR
flags are used
.RE
.PP
\fB\-t\fR \fITAGS\fR
.RS 4
only check rules whose id/tags match these values
.RE
.PP
\fB\-T\fR
.RS 4
list all the tags
.RE
.PP
\fB\-v\fR
.RS 4
Increase verbosity level
.RE
.PP
\fB\-x\fR \fISKIP_LIST\fR
.RS 4
only check rules whose id/tags do not match these values
.RE
.PP
\fB\-\-nocolor\fR
.RS 4
disable colored output
.RE
.PP
\fB\-\-force\-color\fR
.RS 4
Try force colored output (relying on ansible\(cqs code)
.RE
.PP
\fB\-\-exclude=\fR\fIEXCLUDE_PATHS\fR
.RS 4
path to directories or files to skip\&. This option is repeatable\&.
.RE
.SH "AUTHOR"
.sp
ansible\-lint was originally written by Will Thames
.SH "COPYRIGHT"
.sp
Copyright \(co 2013\-2016 Will Thames
.sp
ansible\-lint is released under the terms of the MIT License\&.
.SH "SEE ALSO"
.sp
\fBansible\-playbook\fR(1), \fBansible\fR(1)