Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Panel

cloudmonkey is a command line interface (CLI) tool written in python that leverages Marvin that provides cloudstackAPI. cloudmonkey can be use both as an interactive shell and as a command line tool which simplifies CS configuration and management. It is unofficially distributed by community maintained distribution at the cheese shop http://pypi.python.org/pypi/cloudmonkey/ as well as within the git repository in tools/cli/. It can be used with Apache CloudStack 4.0-incubating and above.

Features

  • Usable as a command line tool and interactive shell
  • All commands are lowercase unlike API
  • Raw api execution support
  • Auto-completion via double <tab>
  • Reverse search using Ctrl+R
  • Emacs compatible keybindings
  • Pipeable output and
  • Unix shell execution
  • Support to handle async jobs using user defined blocking or non-blocking way
  • Colored output

Installation

...

Help for any command can be obtained using help <cmd> or ?<cmd> or <cmd> --help or <cmd> -h, examples:

Code Block
> help list
> help list users
> ?list
> ?list users
> list users --help
> list users -h

A typical help doc for an api will list all available acceptable arguments and required arguments.

...

TODOs

1. Bash/zsh completion
2. DocBook Documentation

About

cloudmonkey was named after the beloved mascot of Apache CloudStack and is powered by Marvin.
Author: The Apache CloudStack Team <cloudstack-dev@incubator.apache.org>
Maintainer: Rohit Yadav <bhaisaab@apache.org>