Skip to content
An dynamically extensible CMD based command shell
Branch: master
Clone or download
Latest commit 3b325c3 Apr 25, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
cloudmesh
tests
.bumpversion.cfg Bump version: 4.0.29 → 4.0.30 Apr 16, 2019
.editorconfig rename editor config.editorconfig Apr 7, 2019
.gitignore new:usr: add variable substitutions in the var command Apr 14, 2017
.travis.yml update travis Apr 7, 2019
LICENSE new:usr: add the basics fora commandshell into cmd5. This has been ex… Feb 23, 2017
Makefile not tags but push Apr 6, 2019
README-old.md improve readme Apr 7, 2019
README.md updated Apr 25, 2019
VERSION Bump version: 4.0.29 → 4.0.30 Apr 16, 2019
plugins.yml chg:dev: added aditional plugin yaml templates Oct 25, 2017
requirements-dev.txt update requirements Apr 4, 2019
requirements.txt work on version management without dependencies for now Apr 6, 2019
setup.cfg remove bumpversion Oct 19, 2018
setup.py
tox.ini new:usr: add the basics fora commandshell into cmd5. This has been ex… Feb 23, 2017

README.md

Cloudmesh cmd5

Version License Python Format Format Travis DOI

Instalation and Documentation

Please note that several packages are available which are pointed to in the instalation documentation.

Links
Documentation https://cloudmesh.github.io/cloudmesh-cloud
Code https://github.com/cloudmesh/cloudmesh-cloud
Instalation Instructions https://github.com/cloudmesh/get

An dynamically extensible CMD based command shell. For en extensive documentation please see

where we also document how to use pyenv virtualenv.

Requirements

  • Python greater equal 3.7.2
  • Python greater equal 2.7.15

Cloudmesh 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 pyenv or venv first before you install cloudmesh. This will make sure the version of cmd5 is installed in the user space.

Setup a virtualenv either with virtualenv or pyenv. We have a tutorial on cloudmesh classes for the use of pyenv. Pyenv is easy to unstall via the installer documented at

$ curl https://pyenv.run | bash

Add the following lines to your .bashrc or .bash_profile

export PATH="~/.pyenv/bin:$PATH"
eval "$(pyenv init -)"
eval "$(pyenv virtualenv-init -)"

For more information see our handbook

CMD5 Shell and Commandline

to run the shell you can activate it with the cms command. cms stands for cloudmesh shell::

$ cms

It will print the banner and enter the shell::

+-------------------------------------------------------+
|   ____ _                 _                     _      |
|  / ___| | ___  _   _  __| |_ __ ___   ___  ___| |__   |
| | |   | |/ _ \| | | |/ _` | '_ ` _ \ / _ \/ __| '_ \  |
| | |___| | (_) | |_| | (_| | | | | | |  __/\__ \ | | | |
|  \____|_|\___/ \__,_|\__,_|_| |_| |_|\___||___/_| |_| |
+-------------------------------------------------------+
|                  Cloudmesh CMD5 Shell                 |
+-------------------------------------------------------+

cms>

To see the list of commands you can say::

cms> help

To see the manual page for a specific command, please use::

help COMMANDNAME

CMD 5 Plugin Mechanism

Cmd5 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

$ pip install cloudmesh-sys

Once you have installed it, execute cms help sys to see the usage. Now you simply can in a new directory execute the sys command as follows, where mycommnad is than name of the command you like to implement.

$ mkdir mycommand
$ cd mycommand
$ cms sys command generate mycommand

A directory with the name cloudmesh-mycommand will be generated that contains the template for the command. You can enter this template and modify the implementation in the folders cloudmesh/mycommand/api and cloudmesh/mycommand/command when installing it with

$ pip install .

The command will be added to the cms command>

An example for the bar command is presented at:

It shows how simple the command definition is (bar.py)::

from __future__ import print_function
from cloudmesh.shell.command import command
from cloudmesh.shell.command import PluginCommand

class BarCommand(PluginCommand):

    @command
    def do_bar(self, args, arguments):
        """
        ::
       
          Usage:
                command -f FILE
                command FILE
                command list
          This command does some useful things.
          Arguments:
              FILE   a file name
          Options:
              -f      specify the file
        """
        print(arguments)

An important difference to other CMD solutions is that our commands can leverage (besides the standrad 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 ussage by the users. Hence, we do recommend that you use docopts.

The transformation is enabled by the @command decorator that takes also the manual page and creates a proper help message for the shell automatically. Thus there is no need to introduce a sepaarte help method as would normally be needed in CMD.

Features

The following highlighted features are available:

You can’t perform that action at this time.