j13k/yaml-lint

A compact command line utility for checking YAML file syntax

yaml-lint

![Software License][ico-license] , _(*1)

A compact command line linting tool for validating YAML files, using the parsing facility of the Symfony Yaml Component., _(*2)

Usage

usage: yaml-lint [options] [input source]

  input source    Path to file(s), or "-" to read from standard input

  -q, --quiet     Restrict output to syntax errors
  -h, --help      Display this help
  -V, --version   Display application version

Install

Composer

To get started using yaml-lint in a project, install it with Composer:, _(*3)

composer require --dev j13k/yaml-lint

It can then be run from the project's vendor/bin directory., _(*4)

To set up yaml-lint globally, install it in the Composer home directory:, _(*5)

composer global require j13k/yaml-lint

It can then be run from the bin directory of Composer home (typically ~/.composer/vendor/bin)., _(*6)

Binary

A binary edition , yaml-lint.phar, is available for download with each release. This embeds the latest stable version of the Symfony Yaml component that is current at the time of the release., _(*7)

The binary can be conveniently installed using PHIVE:, _(*8)

phive install yaml-lint

Docker

yaml-lint is bundled in the phpqa Docker image, which provides a suite of static analysis tools for PHP. See the phpqa project for installation and usage instructions., _(*9)

Change log

Please see CHANGELOG for information on what has changed recently., _(*10)

Credits

• yaml-lint contributors
• Symfony Yaml contributors

License

The MIT License (MIT). Please see LICENCE for more information., _(*11)