Skip to content
Normal view History Permalink
README.rst 1.35 KiB
Newer Older
nimrod's avatar
Scaffolding.
nimrod committed
1 2 3 
YAML tool
#########
nimrod's avatar
CI status badge.  
nimrod committed
4 5 6 7 
.. image:: https://git.shore.co.il/nimrod/yamltool/badges/main/pipeline.svg
    :target: https://git.shore.co.il/nimrod/yamltool/-/commits/main
    :alt: pipeline status
nimrod's avatar
Scaffolding.
nimrod committed
8 9 10 11 12 13 
YAML tool, a clone of the json.tool Python module for YAML.

This tool provides a simple command line interface to validate and pretty-print
YAML documents while trying to preserve as much as possible from the original
documents (like comments and anchors).
nimrod's avatar
First try.  
nimrod committed
14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 
Usage
-----

.. code:: shell

   usage: yt [-h] [infile] [outfile]

   YAML tool, a clone of the json.tool Python module for YAML.

   This tool provides a simple command line interface to validate and pretty-print
   YAML documents while trying to preserve as much as possible from the original
   documents (like comments and anchors).

   positional arguments:
     infile      a YAML file to be validated or pretty-printed
     outfile     write the output of infile to outfile

     optional arguments:
       -h, --help  show this help message and exit
nimrod's avatar
Scaffolding.
nimrod committed
34 35 36 37 38 39 40 41 42 43 44 45 46 
License
-------

This software is licensed under the MIT license (see the :code:`LICENSE.txt`
file).

Author
------

Nimrod Adar, `contact me <nimrod@shore.co.il>`_ or visit my `website
<https://www.shore.co.il/>`_. Patches are welcome via `git send-email
<http://git-scm.com/book/en/v2/Git-Commands-Email>`_. The repository is located
at: https://git.shore.co.il/nimrod/.