First Steps
===========

=============
Installation
=============

This tool is published on `PyPi <https://pypi.org/project/cyclonedx-editor-validator/>`_ and can be installed via pip:

.. code-block:: bash

   python -m pip install cyclonedx-editor-validator

======
Usage
======

The tool comes with built-in command-line help on its usage. To display these hints, run it with:

.. code-block:: bash

    cdx-ev --help              # Lists commands and options
    cdx-ev <command> --help    # Help for a specific command and its options

Or clone the repository and run it as module with:

.. code-block:: bash

    git clone https://github.com/Festo-se/cyclonedx-editor-validator.git # Clone repository
    python -m cdxev --help # Lists commands and options