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é 5ed496f471 Distribution: Remove unneeded `setup_requires` With the new project layout, `pyyaml` is not needed anymore for parsing setup.py.		10 years ago
bin	Introduce the 'cli' module and call it from the script	10 years ago
docs	Refactor project layout to import yamllint alone	10 years ago
tests	Distribution: Remove unneeded `setup_requires`	10 years ago
yamllint	Refactor project layout to import yamllint alone	10 years ago
.gitignore	Doc: Generate documentation with Sphinx	10 years ago
.travis.yml	Tests: Remove Python 2.6 from CI tests	10 years ago
LICENSE	Initial commit	10 years ago
README.rst	Doc: Clarify Python compatibility in README	10 years ago
setup.py	Distribution: Remove unneeded `setup_requires`	10 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
   :alt: CI tests status
.. image::
   https://coveralls.io/repos/github/adrienverge/yamllint/badge.svg?branch=master
   :target: https://coveralls.io/github/adrienverge/yamllint?branch=master
   :alt: Code coverage status
.. image:: https://readthedocs.org/projects/yamllint/badge/?version=latest
   :target: http://yamllint.readthedocs.org/en/latest/?badge=latest
   :alt: Documentation status

Written in Python (compatible with Python 2 & 3).

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

http://yamllint.readthedocs.org/

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

Screenshot
^^^^^^^^^^

.. image:: docs/screenshot.png
   :alt: yamllint screenshot

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