plesty.bench.cli
================

.. py:module:: plesty.bench.cli

.. autoapi-nested-parse::

   ``plesty-bench`` — run ``plesty-server`` commands on a remote bench.

   .. code-block:: bash

       plesty-bench -b lab-bench-03 status
       plesty-bench -b lab-bench-03 field-test pm100d --address mock        # follows the job
       plesty-bench -b lab-bench-03 fetch repos/plesty-pm100d/exp/reports/<slug>/field-test.json -o .
       plesty-bench -b lab-bench-03 ping

   ``-b`` (or ``PLESTY_BENCH``) names the bench, ``--token`` (or
   ``PLESTY_BENCH_TOKEN``) the shared secret. Everything else is handed to the
   bench's ``plesty-server`` unchanged (put ``--`` first when the remote
   arguments start with a dash). Two words are the client's own: ``ping`` and
   ``fetch PATH [-o OUT]``. When the remote command is one that starts a job
   (``install``, ``update``, ``field-test``) it is started ``--no-wait`` on the
   bench and its log is followed here until it ends.



Attributes
----------

.. autoapisummary::

   plesty.bench.cli.JOB_COMMANDS


Functions
---------

.. autoapisummary::

   plesty.bench.cli.app
   plesty.bench.cli.run_remote
   plesty.bench.cli._fetch
   plesty.bench.cli.main


Module Contents
---------------

.. py:data:: JOB_COMMANDS
   :value: ('install', 'update', 'field-test')


.. py:function:: app(address: str | None, token: str | None, timeout: float, argv: tuple[str, Ellipsis]) -> None

   Run `plesty-server ARGV` on the bench at -b; `ping` and `fetch PATH [-o OUT]` are local.


.. py:function:: run_remote(client: plesty.bench.client.BenchClient, args: collections.abc.Sequence[str]) -> int

   Run *args* on the bench; follow the job when it starts one. Returns the exit code.


.. py:function:: _fetch(client: plesty.bench.client.BenchClient, args: collections.abc.Sequence[str]) -> None

.. py:function:: main() -> None

   Console-script entry point.