1SALT-LINT(1) User Commands SALT-LINT(1)
2
3
4
6 salt-lint - A command-line utility that checks for best practices in
7 SaltStack.
8
10 salt-lint [OPTIONS] [FILE ...]
11
13 This document describes the salt-lint program, a linting utility that
14 checks for best practices in SaltStack SLS files.
15
17 positional arguments:
18 FILE one or more files or paths
19
20 options:
21 -h, --help
22 show this help message and exit
23
24 --version
25 show program's version number and exit
26
27 -L list all the rules
28
29 -r RULESDIR
30 specify one or more rules directories using one or more -r argu‐
31 ments. Any -r flags override the default rules in $rules‐
32 dir/saltlint/rules, unless -R is also used.
33
34 -R Use default rules in $rulesdir/saltlint/rules in addition to any
35 extra rules directories specified with -r. There is no need to
36 specify this if no -r flags are used.
37
38 -t TAGS
39 only check rules whose id/tags match these values
40
41 -T list all the tags
42
43 -v Increase verbosity level
44
45 -x SKIP_LIST
46 only check rules whose id/tags do not match these values
47
48 --nocolor, --nocolour
49 disable colored output
50
51 --force-color, --force-colour
52 Try force colored output (relying on salt's code)
53
54 --exclude EXCLUDE_PATHS
55 path to directories or files to skip. This option is repeatable.
56
57 --json parse the output as JSON
58
59 --severity
60 add the severity to the standard output
61
62 -c C Specify configuration file to use. Defaults to ".saltlint"
63
65 $PWD/.saltlint -- Salt-lint checks the working directory for the pres‐
66 ence of this file and applies any configuration found there. The con‐
67 figuration file location can also be overridden via the -c path/to/file
68 CLI flag.
69
70 If a value is provided on both the command line and via a configuration
71 file, the values will be merged (if a list like exclude_paths), or the
72 True value will be preferred, in the case of something like quiet.
73
75 Warpnet B.V. <info@warpnet.nl>
76
78 Report bugs to https://github.com/warpnet/salt-lint/issues.
79
81 Copyright (c) 2020, 2021 Warpnet B.V.
82 Copyright (c) 2013-2018 Will Thames <will@thames.id.au>
83 Copyright (c) 2018 Ansible by Red Hat
84
85 This is free software; see the source for copying conditions. There is
86 NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR
87 PURPOSE.
88
89
90
91salt-lint 0.8.0 November 2021 SALT-LINT(1)