mpk
===

Documentation for the ``mpk`` command and its subcommands.


.. raw:: html

    <!-- spacer -->

.. dropdown:: ``mpk`` — Manage MPK packages and app lifecycle on the connected devices
    :animate: fade-in
    :color: secondary
    :open:

    **Full Help:**

    .. code-block:: text

        Usage:  [OPTIONS] COMMAND [ARGS]...
        
          Manage MPK packages and app lifecycle on the connected devices
        
        Options:
          --help  Show this message and exit.
        
        Commands:
          create  Creates a new MPK package from project sources (eLxr platform...
          deploy  Deploys a prebuilt MPK package to a connected device
          kill    Kills deployed running pipeline on the device.
          launch  Launches deployed pipeline on the device of the same pipeline.
          list    Fetch details of all the deployed pipeline on the connected...
          remove  Removes the deployed pipeline on the device.

    **Usage:**

    .. code-block:: bash

        Usage:  [OPTIONS] COMMAND [ARGS]...


.. dropdown:: ``mpk create`` — Creates a new MPK package from project sources (eLxr platform only)
    :animate: fade-in
    :color: secondary
    :open:

    **Full Help:**

    .. code-block:: text

        Usage:  [OPTIONS]
        
          Creates a new MPK package from project sources (eLxr platform only)
        
        Options:
          -s, --source DIRECTORY          (Required) Folder where project sources are
                                          located.  [required]
          -d, --destination DIRECTORY     (Required) Folder to be used for MPK
                                          creation.  [required]
          --clean                         (Optional) Cleans the source directory of
                                          build artifacts.
          --board-type [davinci|modalix]  (Optional) Specify the type of the Device:
                                          davinci or modalix. Defaults to davinci if
                                          both are available; otherwise, defaults to
                                          the one that exists.  [default: davinci]
          --help                          Show this message and exit.

    **Usage:**

    .. code-block:: bash

        Usage:  [OPTIONS]


.. dropdown:: ``mpk deploy`` — Deploys a prebuilt MPK package to a connected device
    :animate: fade-in
    :color: secondary
    :open:

    **Full Help:**

    .. code-block:: text

        Usage:  [OPTIONS]
        
          Deploys a prebuilt MPK package to a connected device
        
        Options:
          --set-default
          -t, --target TEXT
          -s, --slot TEXT
          -f, --file PATH    [required]
          --help             Show this message and exit.

    **Usage:**

    .. code-block:: bash

        Usage:  [OPTIONS]


.. dropdown:: ``mpk kill`` — Kills deployed running pipeline on the device.
    :animate: fade-in
    :color: secondary
    :open:

    **Full Help:**

    .. code-block:: text

        Usage:  [OPTIONS]
        
          Kills deployed running pipeline on the device. Note: Either --id or --pid
          must be passed with mandatory -t/--target parameter.
        
        Options:
          -i, --id TEXT      Pipeline Id of the Pipeline to kill.
          --pid INTEGER      Pid of the Pipeline to kill.
          -t, --target TEXT  (Required) IP address or FQDN of the device.
          -s, --slot TEXT    (Required) Slot number of the PCIe Soc to connect.
          --help             Show this message and exit.

    **Usage:**

    .. code-block:: bash

        Usage:  [OPTIONS]


.. dropdown:: ``mpk launch`` — Launches deployed pipeline on the device of the same pipeline.
    :animate: fade-in
    :color: secondary
    :open:

    **Full Help:**

    .. code-block:: text

        Usage:  [OPTIONS]
        
          Launches deployed pipeline on the device of the same pipeline.
        
        Options:
          -a, --application TEXT  (Required) Pipeline to Launch.  [required]
          -t, --target TEXT       (Required) IP address or FQDN of the device.
          -s, --slot TEXT         (Required) Slot number of the PCIe Soc to connect.
          --help                  Show this message and exit.

    **Usage:**

    .. code-block:: bash

        Usage:  [OPTIONS]


.. dropdown:: ``mpk list`` — Fetch details of all the deployed pipeline on the connected devices.
    :animate: fade-in
    :color: secondary
    :open:

    **Full Help:**

    .. code-block:: text

        Usage:  [OPTIONS]
        
          Fetch details of all the deployed pipeline on the connected devices.
        
        Options:
          --help  Show this message and exit.

    **Usage:**

    .. code-block:: bash

        Usage:  [OPTIONS]


.. dropdown:: ``mpk remove`` — Removes the deployed pipeline on the device.
    :animate: fade-in
    :color: secondary
    :open:

    **Full Help:**

    .. code-block:: text

        Usage:  [OPTIONS]
        
          Removes the deployed pipeline on the device.
        
        Options:
          -a, --application TEXT  (Required) Pipeline to remove from the board.
                                  [required]
          -t, --target TEXT       (Required) IP address or FQDN of the device.
          -s, --slot TEXT         (Required) Slot number of the PCIe Soc to connect.
          --help                  Show this message and exit.

    **Usage:**

    .. code-block:: bash

        Usage:  [OPTIONS]


Options
-------

No options available.