:mod:`cloudmesh.sys.command.sys`
================================

.. py:module:: cloudmesh.sys.command.sys

.. autoapi-nested-parse::

   The sys command to manage the cmd5 distribution



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

Classes
~~~~~~~

.. autoapisummary::

   cloudmesh.sys.command.sys.SysCommand



.. class:: SysCommand

   Bases: :class:`cloudmesh.shell.command.PluginCommand`

   The system command

   .. method:: do_sys(self, args, arguments)

      ::

      Usage:
        sys upload
        sys commit MESSAGE
        sys command generate NAME [.]
        sys generate command NAME [.]
        sys version VERSION

      This command does some useful things.

      Arguments:
        MESSAGE   the message to commit
        NAME      the command to generate
        VERSION   the version number

      Options:
        -f      specify the file

      Description:
        cms sys command generate NAME

            When you execute this command it
            will generate a  directory tree for a command
            with the name

            cloudmesh-NAME

            To install the command you need to

            cd cloudmesh-NAME
            pip install -e .

            or

            pip install .

        cms sys generate command NAME .
        cms sys command generate NAME .

            the code will be installed in the current directory. This is
            helpful, if you already are in a directory fof the name
            cloudmesh-NAME, e.g. if you already created it in github and
            like to add a command in that github directory.

        The commands 'version', 'commit' and 'upload'
        are only to be used by Gregor.

        cms version
            The version command adds a new version to the
            VERSION file for cmd5, common, and sys.
            This helps to keep the versions aligned across
            these modules.

        cms commit
            The commit  command adds a new version and commits

        cms upload
            The upload command uploads the new version to pypi