LinuxCommandLibrary
GitHub F-Droid Google Play Store

ansible-lint

Check playbooks for best practices

TLDR

Lint a playbook
$ ansible-lint [playbook.yml]
copy
Lint all files in directory
$ ansible-lint
copy
Lint with specific profile
$ ansible-lint --profile [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 [--profile profile] [-x skip] [-f format] [files]

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
-T, --list-tags
List all the tags and the rules they cover
-x rules, --skip-list rules
Skip specific rules or tags
-w rules, --warn-list rules
Treat the listed rules or tags as warnings only
--profile profile
Select a rule profile: min, basic, moderate, safety, shared, or production
-f format, --format format
Output format: brief, full, md, json (alias of codeclimate), codeclimate, quiet, pep8, sarif
--fix [rules]
Auto-fix violations, optionally limited to specific rules or tags
-q, --quiet
Quieter output (may be given twice)
--strict
Return a non-zero exit code on warnings
--offline
Disable installation of requirements and dependencies
-c file, --config-file file
Use the specified configuration file

CONFIGURATION

.ansible-lint

Project-level configuration file for rule selection, skip lists, and profiles.
~/.config/ansible-lint/config.yml
User-level default configuration.

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

ansible(1), ansible-playbook(1), yamllint(1)

RESOURCES

Source code · Documentation

Copied to clipboard
Kai

AltStyle によって変換されたページ (->オリジナル) /