.. _cb2needs:

cb2needs script
===============

The script ``cb2needs`` (Codebeamer to Sphinx-Needs) creates a ``needs.json`` file based on
data coming from a codebeamer server.

Example: ``cb2needs --url my_codebeamer.com --user me --password secret -output needs.json``

For details about ``needs.json`` please read the related `Sphinx-Needs <https://sphinxcontrib-needs.readthedocs.io/>`_
documentation about
`the builder needs <https://sphinxcontrib-needs.readthedocs.io/en/latest/builders.html>`_


Commandline interface
---------------------

With the installation of ``Sphinx-Needs-Codebeamer`` the script ``cb2needs`` got installed and was made available under
the currently used environment.

Type ``cb2needs --help`` to get some help and see available commands.