============
CLI Commands
============

DIPLOMAT supports the following list of subcommands when running it's CLI.

Tracking and Analysis Commands
==============================

.. toctree::
    :hidden:

    _clisummary/diplomat.track_with
    _clisummary/diplomat.track_and_interact
    _clisummary/diplomat.track
    _clisummary/diplomat.annotate
    _clisummary/diplomat.split_videos
    _clisummary/diplomat.tweak
    _clisummary/diplomat.yaml
    _clisummary/diplomat.interact
    _clisummary/diplomat.convert_tracks

.. list-table::
    :widths: auto

    * - :py:cli:`diplomat track_with`
      - Run DIPLOMAT tracking on videos and/or frame stores. Automatically select a frontend based on the passed arguments. Allows for selecting a specific tracker, or predictor.
    * - :py:cli:`diplomat track_and_interact`
      - Run diplomat in interactive tracking mode on the specified config and videos or frame stores. An alias for DIPLOMAT track_with with the SupervisedSegmentedFramePassEngine predictor.
    * - :py:cli:`diplomat track`
      - Run diplomat in a non-interactive tracking mode on the specified config and videos or frame stores. An alias for DIPLOMAT track_with with the SegmentedFramePassEngine predictor. The interactive UI can be restored later using diplomat interact function or cli command.
    * - :py:cli:`diplomat annotate`
      - Have diplomat annotate, or label a video given it has already been tracked.
    * - :py:cli:`diplomat split_videos`
      - Split a video into even length segments. This will produce a list of videos with "-part{number}" appended to the original video name in the same directory as the original video.
    * - :py:cli:`diplomat tweak`
      - Make modifications to DIPLOMAT produced tracking results created for a video using a limited version of the interactive labeling UI. Allows for touching up and fixing any minor issues that may arise after tracking and saving results.
    * - :py:cli:`diplomat yaml`
      - Run DIPLOMAT based on a passed yaml run script. The yaml script should include a 'command' key specifying the DIPLOMAT sub-command to run and an 'arguments' key specifying the list of arguments (key-value pairs) to pass to the command.
    * - :py:cli:`diplomat interact`
      - Open diplomat's interactive UI from a .dipui file. Allows for reloading the UI when diplomat crashes, or for further editing. Settings and backend will be restored automatically based on the settings and info passed during the first run.
    * - :py:cli:`diplomat convert_tracks`
      - Convert files storing final tracking results for a video from other software to diplomat's csv format.

Development Commands
====================

.. toctree::
    :hidden:

    _clisummary/diplomat.predictors.list
    _clisummary/diplomat.predictors.test
    _clisummary/diplomat.predictors.list_settings
    _clisummary/diplomat.frontends.list.all
    _clisummary/diplomat.frontends.list.loaded

.. list-table::
    :widths: auto

    * - :py:cli:`diplomat predictors list`
      - Retrieve and print all currently installed and available predictor plugins that can be used with DIPLOMAT to the console...
    * - :py:cli:`diplomat predictors test`
      - Run the tests for a predictor plugin.
    * - :py:cli:`diplomat predictors list_settings`
      - Prints the available/modifiable settings for a specified predictor plugin.
    * - :py:cli:`diplomat frontends list all`
      - List all frontends currently included with this version of DIPLOMAT.
    * - :py:cli:`diplomat frontends list loaded`
      - List frontends that have successfully loaded, and list their supported functions.

..
    Will Add this back in later when we have actual frontend commands.
    Frontend Specific Commands (Advanced)
    =====================================

    These are custom frontend specific commands available in DIPLOMAT.

    .. toctree::
        :hidden:

    

    .. list-table::
        :widths: auto