CLI API
=======

Command-line interface.

JSON output
-----------

``--json`` produces a single machine-readable result on standard output for:

* ``checkpoints``
* ``validate-project``
* ``test``
* ``info``
* ``train``
* ``tutorial``
* ``config explain``
* ``config profiles``
* ``config show``
* ``config get``
* ``config schema``
* ``config list``

The formatting controls ``--json-indent`` and ``--json-ascii`` apply to these
commands. Human-readable progress that accompanies a JSON result is written to
standard error.

The following commands do not yet have a stable machine-readable result
contract and reject ``--json`` with a nonzero exit status instead of silently
producing human output. Unsupported JSON requests exit with status
64; parser usage errors retain status 2.

The rejecting commands are:

* ``setup``
* ``build``
* ``split``
* ``features``
* ``flat``
* ``clean``
* ``package``
* ``align``
* ``compare``
* ``timings``
* ``config migrate``
* ``config path``
* ``step ci_hmm``
* ``step cd_hmm_untied``

Place the global flag before the command name when checking support. Commands
that support JSON also advertise it in their command help.

.. automodule:: pstrain.cli
   :members:
   :undoc-members:
   :show-inheritance: