debian/ansible-lint.1


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149

'\" t
.\"     Title: ansible-lint
.\"    Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
.\"      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 <will@thames\&.id\&.au>
.sp
ansible\-lint is released under the terms of the MIT License\&.
.SH "SEE ALSO"
.sp
\fBansible\-playbook\fR(1), \fBansible\fR(1)