yamllint

You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

Go to file

Adrien Vergé 48589176c7 Doc: Convert README.md to README.rst		9 years ago
bin	Introduce the 'cli' module and call it from the script	9 years ago
docs	Doc: Generate documentation with Sphinx	9 years ago
tests	Rules: indentation: Add 'check-multi-line-strings' option	9 years ago
yamllint	Doc: Generate documentation with Sphinx	9 years ago
.gitignore	Doc: Generate documentation with Sphinx	9 years ago
.travis.yml	Tests: Travis and Coveralls integration	9 years ago
LICENSE	Initial commit	9 years ago
README.rst	Doc: Convert README.md to README.rst	9 years ago
setup.py	Tests: Travis and Coveralls integration	9 years ago

README.rst

yamllint
========

A linter for YAML files.

.. image::
   https://travis-ci.org/adrienverge/yamllint.svg?branch=master
   :target: https://travis-ci.org/adrienverge/yamllint
.. image::
   https://coveralls.io/repos/github/adrienverge/yamllint/badge.svg?branch=master
   :target: https://coveralls.io/github/adrienverge/yamllint?branch=master

Compatible with Python 2 & 3.

Documentation
-------------

http://yamllint.readthedocs.org/

Short overview
--------------

Installation
^^^^^^^^^^^^

.. code:: bash

 pip install yamllint

Usage
^^^^^

.. code:: bash

 # Lint one or more files
 yamllint my_file.yml my_other_file.yaml ...

.. code:: bash

 # Lint all YAML files in a directory
 yamllint .

.. code:: bash

 # Use a custom lint configuration
 yamllint -c ~/myconfig file.yml

.. code:: bash

 # Output a parsable format (for syntax checking in editors like Vim, emacs...)
 yamllint -f parsable file.yml