README

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

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
  -t, --parse-tags  Enable parsing of custom YAML tags (symfony/yaml 3+ only)
  -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:

composer require --dev j13k/yaml-lint

It can then be run from the project's vendor/bin directory.

To set up yaml-lint globally, install it in the Composer home directory:

composer global require j13k/yaml-lint

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

Note

Binary Name Conflict: Both j13k/yaml-lint and symfony/yaml provide a yaml-lint binary. If you see this message during installation:

Skipped installation of bin bin/yaml-lint for package j13k/yaml-lint:
name conflicts with an existing file

You can either call the binary directly with vendor/j13k/yaml-lint/bin/yaml-lint, or create a symlink:

ln -sf ../j13k/yaml-lint/bin/yaml-lint vendor/bin/yaml-lint

See #181 for details.

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.

The binary can be conveniently installed using PHIVE:

phive install yaml-lint

Verifying Signatures

Release binaries are signed with GPG. To verify the signature:

1. Download both yaml-lint.phar and yaml-lint.phar.asc from the releases page

2. Import the public key:

   gpg --recv-keys 38A182AB413064D7

   Or download it from this repository:

   curl -O https://raw.githubusercontent.com/j13k/yaml-lint/master/j13k_users_noreply_github_com.pub
   gpg --import j13k_users_noreply_github_com.pub

3. Verify the signature:

   gpg --verify yaml-lint.phar.asc yaml-lint.phar

   You should see: Good signature from "John Fitzpatrick (Software signing key) <j13k@users.noreply.github.com>"

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.

Change log

Please see CHANGELOG for information on what has changed recently.

Credits

• yaml-lint contributors
• Symfony Yaml contributors

License

The MIT License (MIT). Please see LICENCE for more information.