documentation

README.md

@@ -11,13 +11,33 @@ yarn run deploy --key <Name of an existing EC2 KeyPair>
 ```bash
 yarn run publish
 ```
+- to see deploy information execute
+```bash
+yarn run describe-stacks
+```
 
 ### Run in develop mode
-
-- install node js and yarn
+- stackName
 - execute
 
 ```bash
-yarn install
-yarn start
-```
\ No newline at end of file
+yarn run install
+yarn run start
+```
+
+### Command API
+###### `yarn run deploy` - Creates AWS CloudFormation Stack
+- stackName - AWS CloudFormation Stack Name default deviceops-hello-world-frontend
+- region - AWS region
+- key - Name of an existing EC2 KeyPair to enable SSH access to the instances
+- instanceType - EC2 Instance Type default t2.micro
+
+###### `yarn run publish` - Sync Web to s3
+- stackName - AWS CloudFormation Stack Name default deviceops-hello-world-frontend
+
+###### `yarn describe-stacks` - Returns the stack description
+- stackName - AWS CloudFormation Stack Name default deviceops-hello-world-frontend
+
+###### `yarn delete` - Deletes stack. Once the call completes successfully, stack deletion starts.
+- stackName - AWS CloudFormation Stack Name default deviceops-hello-world-frontend
+- region - AWS region
\ No newline at end of file

cli/app.js

@@ -13,7 +13,7 @@ const NO_VALIDATE = null;
 prog
     .command('deploy', 'Deploy CloudFormation template to AWS')
     .option('--stackName <stackName>', 'Stack Name', NO_VALIDATE, DEFAULT_STACK_NAME)
-    .option('--region <region>', 'Stack Name', NO_VALIDATE, null, false)
+    .option('--region <region>', 'AWS region', NO_VALIDATE, null, false)
     .option('--key <key>', 'Name of an existing EC2 KeyPair to enable SSH access to the instances', NO_VALIDATE, null, true)
     .option('--instanceType <instanceType>', 'EC2 Instance Type', NO_VALIDATE, DEFAULT_INSTANCE_TYPE, false)
     .action((args, options) => {
@@ -52,7 +52,7 @@ prog
 prog
     .command('describe-stacks', 'Deploy CloudFormation template to AWS')
     .option('--stackName <stackName>', 'Stack Name', NO_VALIDATE, DEFAULT_STACK_NAME)
-    .option('--region <region>', 'Stack Name', NO_VALIDATE, null, false)
+    .option('--region <region>', 'AWS region', NO_VALIDATE, null, false)
     .action((args, options) => {
 
         if (options.region) {
@@ -71,7 +71,7 @@ prog
 prog
     .command('delete', 'Delete CloudFormation template')
     .option('--stackName <stackName>', 'Stack Name', NO_VALIDATE, DEFAULT_STACK_NAME)
-    .option('--region <region>', 'Stack Name', NO_VALIDATE, null, false)
+    .option('--region <region>', 'AWS region', NO_VALIDATE, null, false)
     .action((args, options) => {
 
         if (options.region) {