ANSIBLE-LINT(1)

🎀 ansible-lint(1) 🎀

User Commands section, and it is giving main character energy 💅

✨ NAME ✨

ansible-lint is the lint tool for Ansible playbooks 🧚 It checks your playbooks for problems so you don't have to find them the hard way 😭

💖 DESCRIPTION 💖

Okay so here's the usage line, bestie 🫶

usage: ansible-lint [-h] [-P | -L | -T]

[-f {brief,full,md,json,codeclimate,quiet,pep8,sarif}]
      [--sarif-file SARIF_FILE] [-q] [--profile
      {min,basic,moderate,safety,shared,production}] [-p]
      [--project-dir PROJECT_DIR] [-r RULESDIR] [-R] [-s] [--write
      [WRITE_LIST]] [--show-relpath] [-t TAGS] [-v] [-x SKIP_LIST]
      [--generate-ignore] [-w WARN_LIST] [--enable-list ENABLE_LIST]
      [--nocolor] [--force-color] [--exclude EXCLUDE_PATHS
      [EXCLUDE_PATHS ...]]  [-c CONFIG_FILE] [-i IGNORE_FILE]
      [--offline] [--version] [lintables ...]

🌸 positional arguments 🌸

• lintables — one or more files or paths 🍓 If you leave it out, ansible-lint switches to auto-detection mode, so it does the looking for you ✨

💅 options 💅

• -h, --help — shows this help message and exits 🙈
• -P, --list-profiles — lists all the profiles 🦋 There are no formatting options for this one.
• -L, --list-rules — lists all the rules 📋 For this, the only -f formats that work are {brief, full, md}, and brief is the default.
• -T, --list-tags — lists all the tags and which rules they cover 🏷️ Bump up the verbosity with -v if you want the opt-in tag and its rules to show up too 👀
• -f {brief,full,md,json,codeclimate,quiet,pep8,sarif}, --format {brief,full,md,json,codeclimate,quiet,pep8,sarif} — picks the stdout formatting 💅 json is just an alias for codeclimate. (default: None)
• --sarif-file SARIF_FILE — the SARIF output file 📁
• -q — quieter, with less verbosity 🤫 You can use it twice if you really want it hushed 🫶
• --profile {min,basic,moderate,safety,shared,production} — choose which rules profile you want to use 👑
• -p, --parseable — parseable output, same vibe as -f pep8 ✨
• --project-dir PROJECT_DIR — where your project or repository lives 🌈 It gets autodetected based on where the configuration file is.
• -r RULESDIR, --rules-dir RULESDIR — point it at custom rule directories 🔥 Add -R if you want to keep using the embedded rules from /usr/lib/python3/dist-packages/ansiblelint/rules too.
• -R — keeps the default rules when you're using -r 💜
• -s, --strict — returns a non-zero exit code for warnings as well as errors 🥺 Strict and serious 💀
• --write [WRITE_LIST] — lets ansible-lint reformat YAML files and run rule transforms ✨ Reformatting standardizes spacing, quotes, and so on, and a rule transform can fix or simplify the issue that rule found 🧚 You can limit which transforms run (that's the write_list) by passing the keywords all or none, or a comma-separated list of rule ids or rule tags. YAML reformatting happens whenever --write or --write= is used 💖 --write and --write=all are the same thing, and they let every transform run 🙌 The effective list comes from write_list in the config file first, then whatever --write args you pass on the commandline gets applied after 🎀 --write=none resets the transform list so you get YAML reformatting without any transforms running. For example, --write=none,rule-id will ignore write_list in the config file and only run the rule-id transform 💅

Heads up, bestie: the --write flag is what lets ansible-lint actually rewrite your files. Use it with care 😭

• --show-relpath — displays paths relative to the current working directory 🦋
• -t TAGS, --tags TAGS — only checks rules whose id or tags match these values 🎯
• -v — ups the verbosity level, and -vv goes even higher 📢
• -x SKIP_LIST, --skip-list SKIP_LIST — only checks rules whose id or tags do not match these values 🙈 For example: --skip-list=name,run-once
• --generate-ignore — generates a text file called .ansible-lint-ignore that ignores every violation it finds 🫠 Each line holds a filename and a rule id, separated by a space 📝
• -w WARN_LIST, --warn-list WARN_LIST — only warns about these rules, unless the config file overrides it 🚨 The current default value is: experimental, jinja[spacing], fqcn[deep]
• --enable-list ENABLE_LIST — turns on optional rules by their tag name ✨
• --nocolor — turns off colored output, same as NO_COLOR=1 🖤
• --force-color — forces colored output, same as FORCE_COLOR=1 🌈
• --exclude EXCLUDE_PATHS [EXCLUDE_PATHS ...] — paths to directories or files you want to skip 🚫 You can repeat this option as many times as you need 🫶
• -c CONFIG_FILE, --config-file CONFIG_FILE — picks the configuration file to use 🎀 By default it looks for .ansible-lint, .config/ansible-lint.yml, or .config/ansible-lint.yaml 👀
• -i IGNORE_FILE, --ignore-file IGNORE_FILE — picks the ignore file to use 🧹 By default it looks for .ansible-lint-ignore or .config/ansible-lintignore.txt 💜
• --offline — disables installing requirements.yml and refreshing the schema 📴
• --version — the version flag 🔢 The page doesn't give any more detail than that, so that's the tea ☕

---

Okay that's the whole manual, bestie 💖 Source: ansible-lint, dated June 2023 🦋 Stay linted, stay iconic 🌸✨