• AnsibleFest
  • Products
  • Community
  • Webinars & Training
  • Blog
Ansible Logo
Ansible Lint Documentation
Ansible Lint Documentation
latest

Philosophy

  • Philosophy of ansible-lint
    • History and the future
    • Style and formatting
    • Q&A
      • Why does ansible-lint not accept all valid ansible syntax?
      • What if I do not agree with a specific rule?
      • Who decides on best practices are adopted?
      • Do I need to pass all rules to get my collection certified?
      • Why lots of official Ansible docs examples are not passing linting?
      • Linter requires an Ansible version newer than what I use in production?

Installing

  • Installing
    • Using pip or pipx
    • From Source

Usage

  • Usage
    • Command Line Options
    • Temporary files
    • Progressive mode
    • CI/CD
    • Linting Playbooks and Roles
    • Examples

Configuring

  • Configuring
    • Configuration File
    • Pre-commit Setup

Rules

  • Rules
    • Specifying Rules at Runtime
      • Using Tags to Include Rules
      • Excluding Rules
      • Ignoring Rules
    • False Positives: Skipping Rules
  • Custom Rules
    • Creating Custom Rules
    • Packaging Custom Rules
  • Default Rules
    • command-instead-of-module
    • command-instead-of-shell
    • deprecated-bare-vars
    • deprecated-command-syntax
    • deprecated-local-action
    • deprecated-module
    • fqcn-builtins
    • git-latest
    • hg-latest
    • ignore-errors
    • inline-env-var
    • internal-error
    • key-order
    • literal-compare
    • load-failure
    • meta-incorrect
    • meta-no-info
    • meta-no-tags
    • meta-video-links
    • no-changed-when
    • no-handler
    • no-jinja-nesting
    • no-jinja-when
    • no-loop-var-prefix
    • no-relative-paths
    • no-tabs
    • package-latest
    • parser-error
    • partial-become
    • playbook-extension
    • risky-file-permissions
    • risky-octal
    • risky-shell-pipe
    • role-name
    • schema
    • syntax-check
    • unnamed-task
    • var-naming
    • var-spacing
    • yaml
      • Problematic code
      • Correct code

Contributing

  • Contributing to Ansible-lint
    • Standards
  • Module dependency graph
  • Adding a new rule
  • Private unsupported (dev) API autodoc
    • ansiblelint package
      • Subpackages
      • Submodules
      • Module contents
Ansible Lint Documentation
  • »
  • ansiblelint
  • Edit on GitHub

ansiblelintΒΆ

  • ansiblelint package
    • Subpackages
      • ansiblelint._internal package
        • Submodules
        • Module contents
      • ansiblelint.formatters package
        • Module contents
      • ansiblelint.rules package
        • Subpackages
        • Submodules
        • Module contents
      • ansiblelint.schemas package
        • Module contents
      • ansiblelint.testing package
        • Submodules
        • Module contents
    • Submodules
      • ansiblelint.__main__ module
      • ansiblelint._mockings module
      • ansiblelint._version module
      • ansiblelint.app module
      • ansiblelint.cli module
      • ansiblelint.color module
      • ansiblelint.config module
      • ansiblelint.constants module
      • ansiblelint.errors module
      • ansiblelint.file_utils module
      • ansiblelint.generate_docs module
      • ansiblelint.loaders module
      • ansiblelint.logger module
      • ansiblelint.runner module
      • ansiblelint.skip_utils module
      • ansiblelint.text module
      • ansiblelint.transformer module
      • ansiblelint.utils module
      • ansiblelint.version module
      • ansiblelint.yaml_utils module
    • Module contents
Next Previous

© Copyright 2013-2021 Ansible, Inc. Revision d51f97d9. Last updated on May 17, 2022.

Built with Sphinx using a Sphinx Ansible Theme that is based on the Read the Docs theme and is maintained by the Ansible Community.