Package: cloudmesh-cmd5
Cloudmesh cmd5Installation and DocumentationPlease note that several packages are available which are pointed to in the
installation documentation.LinksDocumentationhttps://cloudmesh.github.io/cloudmesh-cloudCodehttps://github.com/cloudmesh/cloudmesh-cloudInstallation Instructionshttps://github.com/cloudmesh/getAn dynamically extensible CMD based command shell. For en extensive
documentation please seehttps://github.com/cloudmesh-community/book/blob/main/vonLaszewski-cloud.epub?raw=truewhere we also document how to use pyenv virtualenv.RequirementsPython greater equal 3.8.1Cloudmesh was able to run on earlier versions of python, but we do prefer to
test it on the newest version.We recommend that you use venv first before you install cloudmesh. ThisYou can as user install cmd5 withpipinstallcloudemsh-cmd5Developers should look at our cloudmesh manual.https://cloudmesh.github.io/cloudmesh-manual/CMD5 Shell and Commandlineto run the shell you can activate it with the cms command. cms stands
for cloudmesh shell::$cmsIt will print the banner and enter the shell::+-------------------------------------------------------+
|   ____ _                 _                     _      |
|  / ___| | ___  _   _  __| |_ __ ___   ___  ___| |__   |
| | |   | |/ _ \| | | |/ _` | '_ ` _ \ / _ \/ __| '_ \  |
| | |___| | (_) | |_| | (_| | | | | | |  __/\__ \ | | | |
|  \____|_|\___/ \__,_|\__,_|_| |_| |_|\___||___/_| |_| |
+-------------------------------------------------------+
|                  Cloudmesh CMD5 Shell                 |
+-------------------------------------------------------+

cms>To see the list of commands you can say::cms> helpDocumentedcommands(typehelp<topic>):========================================EOFcommandsdefaulthelppauseqshellsysversion
bannerconfigechoinfopluginquitsleeptestcleardebugguimanpysetstopwatchvarTo see the manual page for a specific command, please use::cms> help COMMANDNAMEA full manual page is available athttps://cloudmesh.github.io/cloudmesh-manual/CMD 5 Plugin MechanismCmd5 comes with a sophisticated plugin mechanism. Commands can be readily
designed from the sys command.The sys command can be installed either from source (as discussed previously) or
via pip$pipinstallcloudmesh-sysOnce you have installed it, executecms help systo see the usage. Now you
simply can in a new directory execute the sys command as follows, wheremycommnadis than name of the command you like to implement.$mkdirmycommand
$cdmycommand
$cmssyscommandgeneratemycommand.A directory with the namecloudmesh-mycommandwill be generated that contains
the template for the command. You can enter this template and modify the
implementation in the folderscloudmesh/mycommand/apiandcloudmesh/mycommand/commandwhen installing it with$ pip install .The command will be added to the cms command>An example for the bar command is presented at:cloudmesh/bar/command/bar.pyIt shows how simple the command definition is (bar.py)::fromcloudmesh.shell.commandimportcommandfromcloudmesh.shell.commandimportPluginCommand

classBarCommand(PluginCommand):@commanddefdo_bar(self,args,arguments):"""::Usage:command -f FILEcommand FILEcommand listThis command does some useful things.Arguments:FILE   a file nameOptions:-f      specify the file"""print(arguments)An important difference to other CMD solutions is that our commands
can leverage (besides the standard definition), docopts as a way to
define the manual page. This allows us to use arguments as dict and
use simple if conditions to interpret the command. Using docopts has
the advantage that contributors are forced to think about the command
and its options and document them from the start. Previously we used
not to use docopts and argparse was used. However we noticed that for
some contributions the lead to commands that were either not properly
documented or the developers delivered ambiguous commands that
resulted in confusion and wrong usage by the users. Hence, we do
recommend that you use docopts.The transformation is enabled by the@commanddecorator that takes
also the manual page and creates a proper help message for the shell
automatically. Thus there is no need to introduce a separate help
method as would normally be needed in CMD.FeaturesThe following highlighted features are available:easy command integration through separate modulesmulti cloud environments (under development) though cloudmesh-cloud pluginopenapi integration through cloudmesh-openapi plugingeneral commands as documented at in themanualsuch asadmin,banner,clear,echo,default,info,pause,plugin,quit,shell,sleep,stopwatch,sys,var,version,open,
and othersNew FeaturesSupport for terminals with dark backgroundSupport for python in variable assignmentscms set a=\"py 1 + 1\"
a='2'Support for executing python in a py commandcms py 1 + 1
2Support for shell commands in the variabe valuecms set a=\!pwdSupport for reading values from a yaml configuration file in~/.cloudmesh/cloudmesh.yamlcms set a=cloudmesh.profile.userwhere it is defined ascloudmesh:
  profile:
    user: gregorManual PageDocumented commands (type help <topic>):
========================================
EOF     commands  echo  q        shell    sysinfo    
banner  debug     man   quit     sleep    term     
bar     default   help  pause    var      version
clear   dryrun    info  py       set      sys