SALT-LINT(1)

💖 SALT-LINT(1) 💖

okay so bestie, welcome to salt-lint, part of the User Commands crew 🎀

---

✨ NAME ✨

salt-lint — a command-line utility that checks for best practices in SaltStack. that's it, that's the whole vibe: it's your little lint goblin for SaltStack 🧚

---

🌸 SYNOPSIS 🌸

salt-lint [OPTIONS] [FILE ...]

---

💅 DESCRIPTION 💅

this doc is literally all about the salt-lint program — a linting utility that checks for best practices in SaltStack SLS files. it looks at your SLS files, goes "hmm bestie, this is giving not-best-practice", and tells you. no cap 💅

---

👑 OPTIONS 👑

🦋 positional arguments: 🦋

• FILE — one or more files or paths. feed it your files, feed it your paths, it eats both fr fr

🌈 options: 🌈

• -h, --help — show this help message and exit. the classic "help me pls" button 🫶
• --version — show program's version number and exit. for when you just gotta know which era of salt-lint you're living in
• -L — list all the rules. every single one, laid out, iconic behavior 👑
• -r RULESDIR — specify one or more rules directories using one or more -r arguments. heads up tho: any -r flags override the default rules in $rulesdir/saltlint/rules, unless -R is also used. so like, don't be surprised when your defaults dip out 😭
• -R — use default rules in $rulesdir/saltlint/rules in addition to any extra rules directories you specified with -r. there's literally no need to specify this if you didn't use any -r flags. it's giving "only if you need it" energy ✨
• -t TAGS — only check rules whose id/tags match these values. very picky, very demure, only the tags you asked for 💅
• -T — list all the tags. the full tag catalogue, go off
• -v — increase verbosity level. more words! more details! main character energy for your terminal 💖
• -x SKIP_LIST — only check rules whose id/tags do not match these values. the opposite of -t, the hater of tags, we respect it 🙈
• --nocolor, --nocolour — disable colored output. for the monochrome besties (and also the British spelling besties, we see you 🇬🇧)
• --force-color, --force-colour — try force colored output (relying on salt's code). note the "try" — it's relying on salt's code, so it's doing its best, okay 😭
• --exclude EXCLUDE_PATHS — path to directories or files to skip. this option is repeatable, so stack 'em up like little "not you" signs 🚫
• --json — parse the output as JSON. for when you want your lint results to be machine-readable and slightly intimidating
• --severity — add the severity to the standard output. now you know how bad it is, not just that it's bad 💀
• -c C — specify configuration file to use. defaults to ".saltlint" — cute name, slay

---

🍓 FILES 🍓

• $PWD/.saltlint — salt-lint checks the working directory for the presence of this file and applies any configuration found there. the configuration file location can also be overridden via the -c path/to/file CLI flag.

and okay so here's the merge situation, pay attention bestie:

if a value is provided on both the command line and via a configuration file, the values will be merged (if it's a list like exclude_paths), or the True value will be preferred, in the case of something like quiet. no fights, no drama, they just combine 🌸

---

🫶 AUTHOR 🫶

Warpnet B.V. <info@warpnet.nl> — the legends behind all this ✨

---

💀 REPORTING BUGS 💀

found a bug? not you, bestie — report bugs to https://github.com/warpnet/salt-lint/issues. they want to hear it, fr fr

---

⭐ COPYRIGHT ⭐

Copyright (c) 2020, 2023 Warpnet B.V. Copyright (c) 2013-2018 Will Thames <will@thames.id.au> Copyright (c) 2018 Ansible by Red Hat

this is free software; see the source for copying conditions. there is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. so like, it's free, but it comes with zero promises. read the source if you wanna know the deal 💜

---

and that's the whole page bestie!! this was salt-lint version 0.9.2, dated February 2023 — shoutout to the SALT-LINT(1) era, we love her, mwah 💖💅✨