From f4b9a3ae04501861b19aa8968645c8dcdfedc3c8 Mon Sep 17 00:00:00 2001 From: Angel Pizarro Date: Fri, 13 Jun 2014 21:01:37 -0400 Subject: [PATCH] pasted help documentation into the readme --- cli/README | 28 +++++++++++++++++++++++++++- 1 file changed, 27 insertions(+), 1 deletion(-) diff --git a/cli/README b/cli/README index 49c31255a6..5f8523d44c 100644 --- a/cli/README +++ b/cli/README @@ -1 +1,27 @@ -cfncluster is an example framework for launching clusters. \ No newline at end of file +cfncluster is an example framework for launching clusters. + + usage: cfncluster [-h] [--config CONFIG_FILE] [--region REGION] [--nowait] + {create,update,stop,delete,status,list,instances,sshmaster} + ... + + cfncluster is the a tool to launch and manage cluster. + + positional arguments: + {create,update,stop,delete,status,list,instances,sshmaster} + create creates a cluster + update update a running cluster + stop stop a cluster + delete delete a cluster + status pull the current status of the cluster + list display a list of stacks associated with cfncluster + instances display a list of all instances in a cluster + sshmaster ssh to Master instance + + optional arguments: + -h, --help show this help message and exit + --config CONFIG_FILE, -c CONFIG_FILE + specify a alternative config file + --region REGION, -r REGION + specify a specific region to connect to + --nowait, -nw do not wait for stack events, after executing stack + command