cloudstack-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From chipchild...@apache.org
Subject [7/7] git commit: Adding some content to index.rst
Date Tue, 24 Sep 2013 17:52:50 GMT
Adding some content to index.rst


Project: http://git-wip-us.apache.org/repos/asf/cloudstack-cloudmonkey/repo
Commit: http://git-wip-us.apache.org/repos/asf/cloudstack-cloudmonkey/commit/34665b37
Tree: http://git-wip-us.apache.org/repos/asf/cloudstack-cloudmonkey/tree/34665b37
Diff: http://git-wip-us.apache.org/repos/asf/cloudstack-cloudmonkey/diff/34665b37

Branch: refs/heads/master
Commit: 34665b37833fbe2fbad2349b6fc5c3893ca39643
Parents: 34f0b70
Author: Chip Childers <chipchilders@apache.org>
Authored: Tue Sep 24 13:48:46 2013 -0400
Committer: Chip Childers <chipchilders@apache.org>
Committed: Tue Sep 24 13:48:46 2013 -0400

----------------------------------------------------------------------
 docs/source/index.rst | 32 +++++++++++++++++++++++---------
 1 file changed, 23 insertions(+), 9 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/cloudstack-cloudmonkey/blob/34665b37/docs/source/index.rst
----------------------------------------------------------------------
diff --git a/docs/source/index.rst b/docs/source/index.rst
index e1902db..8c5dd2c 100644
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -1,17 +1,31 @@
-.. Apache CloudStack CloudMonkey documentation master file, created by
-   sphinx-quickstart on Tue Sep 24 13:08:09 2013.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
+Apache CloudStack CloudMonkey
+=============================
 
-Welcome to Apache CloudStack CloudMonkey's documentation!
-=========================================================
+The Apache CloudStack CloudMonkey is a command line interface (CLI) tool for CloudStack written
in Python. cloudmonkey
+can be use both as an interactive shell and as a command line tool which simplifies CS configuration
and management.
 
-Contents:
+**Features**
 
-.. toctree::
-   :maxdepth: 2
+#. Usable as a command line tool and interactive shell
+#. All commands are lowercase unlike API
+#. Api Discovery using sync feature, with build time api precaching for failsafe sync
+#. Raw api execution support
+#. Auto-completion via double <tab>
+#. Reverse search using Ctrl+R
+#. Emacs compatible keybindings
+#. Pipeable output
+#. Unix shell execution
+#. Support to handle async jobs using user defined blocking or non-blocking way
+#. Tabular or JSON output with filtering of table columns
+#. Colored output
+#. Api parameter value completion (based on predication, fuzzy results may fail sometimes)
+
+Instructions for working with CloudMonkey can be found here:
 
+https://cwiki.apache.org/confluence/display/CLOUDSTACK/CloudStack+cloudmonkey+CLI
 
+.. toctree::
+   :maxdepth: 2
 
 Indices and tables
 ==================


Mime
View raw message