=============
CLI interface
=============

Please note that this is only a small selection of the available commands and
options.

Please run ``lpcraft --help`` to see all commands.

lpcraft run
-----------

This command runs all jobs listed via pipelines from a configuration file.

**Example:**

``lpcraft run``

lpcraft run optional arguments
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

- ``--package-repository`` (provide an additional repository), e.g.
  ``lpcraft run --package-repository "deb http://archive.ubuntu.com/ubuntu/ focal main restricted"``
  This option is repeatable.

- ``--plugin-setting``, e.g.
  ``lpcraft run --plugin-setting="foo=bar"``

  This option is repeatable.

- ``--replace-package-repositories SOURCE_LINE``, e.g.
  ``lpcraft run --replace-package-repositories "deb http://archive.ubuntu.com/ubuntu/ focal main restricted"``

  This option is repeatable.


- ``--secrets``, e.g.
  ``lpcraft run --secrets="<path-to-configuration-file>"``

  The configuration file should look like...

  .. code::

    key: secret
    another_key: another_secret

- ``--set-env KEY=VALUE``, e.g.
  ``lpcraft run --set-env="PIP_INDEX_URL=http://pypi.example.com/simple"``

  This option is repeatable.

- ``--gpu-nvidia`` (experimental)

  This option requires an NVIDIA GPU on the host system; if passed on a
  system without such a GPU, container setup will fail.

lpcraft run-one
---------------

This command runs one specified job.

**Example:**

``lpcraft run-one test 0``

where ``test`` is the job name and ``0`` is the index of the job/matrix.

lpcraft run-one optional arguments
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

- ``--package-repository`` (provide an additional repository), e.g.
  ``lpcraft run-one --package-repository "deb http://archive.ubuntu.com/ubuntu/ focal main restricted" test 0``
  This option is repeatable.

- ``--plugin-setting``, e.g.
  ``lpcraft run-one --plugin-setting="foo=bar" test 0``

  This option is repeatable.

- ``--replace-package-repositories SOURCE_LINE``, e.g.
  ``lpcraft run-one --replace-package-repositories "deb http://archive.ubuntu.com/ubuntu/ focal main restricted" test 0``

  This option is repeatable.

- ``--secrets``, e.g.
  ``lpcraft run-one --secrets="<path-to-configuration-file>" test 0``

  The configuration file should look like...

  .. code::

    key: secret
    another_key: another_secret

- ``--set-env KEY=VALUE``, e.g.
  ``lpcraft run-one --set-env="PIP_INDEX_URL=http://pypi.example.com/simple" test 0``

  This option is repeatable.