client.cli_v1
=============

.. py:module:: client.cli_v1

.. autoapi-nested-parse::

   Client command line interface for workflow/task status and concurrency limiting.

   .. deprecated:: 2.3.0
       This module is deprecated. The new Click-based CLI is in jobmon.client.cli.main.
       This module is kept for backward compatibility and will be removed in version 3.0.



Classes
-------

.. autoapisummary::

   client.cli_v1.ClientCLI


Functions
---------

.. autoapisummary::

   client.cli_v1.main


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

.. py:class:: ClientCLI

   Bases: :py:obj:`jobmon.core.cli.CLI`


   Client command line interface for workflow/task status and concurrency limiting.

   .. deprecated:: 2.3.0
       Use the new Click-based CLI instead: ``from jobmon.client.cli import cli, main``

   Initialization of client CLI.


   .. py:attribute:: parser


   .. py:method:: limit_checker(limit: Any) -> int
      :staticmethod:


      Coerce to int and check that the limit is greater than 0.



   .. py:method:: workflow_status(args: argparse.Namespace) -> None
      :staticmethod:


      Workflow status checking options.



   .. py:method:: workflow_tasks(args: argparse.Namespace) -> None
      :staticmethod:


      Check the tasks for a given workflow.



   .. py:method:: task_template_resources(args: argparse.Namespace) -> None
      :staticmethod:


      Aggregates the resource usage for a given TaskTemplateVersion.



   .. py:method:: task_status(args: argparse.Namespace) -> None
      :staticmethod:


      Check task status.



   .. py:method:: update_task_status(args: argparse.Namespace) -> None
      :staticmethod:


      Manually update task status for resumes, reruns, etc.



   .. py:method:: concurrency_limit(args: argparse.Namespace) -> None
      :staticmethod:


      Set a limit for the number of tasks that can run concurrently.



   .. py:method:: task_dependencies(args: argparse.Namespace) -> None
      :staticmethod:


      Get task's upstream and downstream tasks and their status.



   .. py:method:: workflow_reset(args: argparse.Namespace) -> None
      :staticmethod:


      Manually reset a workflow.



   .. py:method:: jobmon_version(args: argparse.Namespace) -> None
      :staticmethod:


      Return the jobmon version.



   .. py:method:: resource_yaml(args: argparse.Namespace) -> None
      :staticmethod:


      Create resource yaml.



   .. py:method:: resume_workflow(args: argparse.Namespace) -> None
      :staticmethod:


      Resume a workflow from a workflow ID.



   .. py:method:: get_filepaths(args: argparse.Namespace) -> None
      :staticmethod:



   .. py:method:: update_config(args: argparse.Namespace) -> None
      :staticmethod:


      Update a configuration value in the defaults.yaml file.



.. py:function:: main(argstr: Optional[str] = None) -> None

   Create CLI.