From f66661e36d1170d5ee756351b4f28de366141bb2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Adrien=20Verg=C3=A9?= Date: Mon, 11 Feb 2019 14:07:56 +0100 Subject: [PATCH] docs(cli): Add a paragraph about standard input See commit 05dfcbc "cli: Add command line option - to read from standard input", cc @miguelbarao. --- docs/quickstart.rst | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/quickstart.rst b/docs/quickstart.rst index 6165f30..427a9f3 100644 --- a/docs/quickstart.rst +++ b/docs/quickstart.rst @@ -50,6 +50,12 @@ You can also lint all YAML files in a whole directory: yamllint . +Or lint a YAML stream from standard input: + +.. code:: bash + + echo -e 'this: is\nvalid: YAML' | yamllint - + The output will look like (colors are not displayed here): ::