LinuxCommandLibrary

ansible-lint

TLDR

Lint a playbook

$ ansible-lint [playbook.yml]
copy
Lint all files in directory
$ ansible-lint
copy
Lint with specific profile
$ ansible-lint -p [production] [playbook.yml]
copy
List all rules
$ ansible-lint -L
copy
Skip specific rules
$ ansible-lint --skip-list [yaml,risky-shell-pipe] [playbook.yml]
copy
Output in JSON format
$ ansible-lint -f json [playbook.yml]
copy

SYNOPSIS

ansible-lint [-p profile] [-x skip] [-f format] [playbooks]

DESCRIPTION

ansible-lint checks Ansible playbooks, roles, and collections for practices and behaviors that could potentially be improved. It identifies deprecated syntax, security concerns, style issues, and best practice violations.
The tool helps maintain consistent, high-quality Ansible code and catch common mistakes before deployment.

PARAMETERS

-L, --list-rules

List all available rules
-x rules, --skip-list rules
Skip specific rules
-w rules, --warn-list rules
Treat rules as warnings only
-p profile, --profile profile
Select rule profile (min, basic, moderate, safety, shared, production)
-f format, --format format
Output format: rich, plain, json, codeclimate, sarif
--fix
Attempt to fix linting errors
-q, --quiet
Quieter output
--strict
Treat warnings as errors
-c file, --config-file file
Configuration file

CAVEATS

Not all rules apply to all use cases; configure skip-list appropriately. The --fix option may not handle all issues. False positives may occur with complex variable usage.

HISTORY

ansible-lint was created to help enforce best practices in Ansible projects. It became an official Ansible project and has been actively maintained with evolving rule sets.

SEE ALSO

Copied to clipboard