From 8d60d071df300e84e54e9f1d804891396aea48fe Mon Sep 17 00:00:00 2001
From: Mriyam Tamuli <mbtamuli@gmail.com>
Date: Sun, 27 Nov 2016 19:24:57 +0530
Subject: [PATCH] Docs and help text for apps:report subcommand

---
 docs/deployment/application-management.md | 49 +++++++++++++++++++++++
 plugins/apps/commands                     |  1 +
 2 files changed, 50 insertions(+)

diff --git a/docs/deployment/application-management.md b/docs/deployment/application-management.md
index 9b44c3ebc..38d8993d2 100644
--- a/docs/deployment/application-management.md
+++ b/docs/deployment/application-management.md
@@ -7,6 +7,7 @@ apps                                           # List your apps
 apps:create <app>                              # Create a new app
 apps:destroy <app>                             # Permanently destroy an app
 apps:rename <old-app> <new-app>                # Rename an app
+apps:report [<app>] [<flag>]                   # Display report about an app
 ```
 
 ## Usage
@@ -112,3 +113,51 @@ Renaming node-js-app to io-js-app... done
 ```
 
 This will copy all of your app's contents into a new app directory with the name of your choice, delete your old app, then rebuild the new version of the app and deploy it. All of your config variables, including database urls, will be preserved.
+
+### Displaying reports about an app
+
+> New as of 0.7.2
+
+You can get a report about the deployed apps using the `apps:report` command:
+
+```shell
+dokku apps:report
+```
+
+```
+=====> node-js-sample
+       App dir:             /home/dokku/node-js-sample
+       Git sha:             dbddc3f                  
+       App cid:             7b18489c98be             
+       Status:              running                  
+=====> python-sample
+not deployed
+=====> ruby-sample
+       App dir:             /home/dokku/ruby-sample
+       Git sha:             a2d477c
+       App cid:             78a44d71012a
+       Status:              running
+```
+
+You can run the command for a specific app also.
+
+```shell
+dokku apps:report node-js-sample
+```
+
+```
+=====> node-js-sample
+       App dir:             /home/dokku/node-js-sample
+       Git sha:             dbddc3f                  
+       App cid:             7b18489c98be             
+       Status:              running   
+```
+
+You can pass flags which will output only the value of the specific information you want. For example:
+```shell
+dokku apps:report node-js-sample --git-sha
+```
+
+```
+dbddc3f
+```
diff --git a/plugins/apps/commands b/plugins/apps/commands
index c46d255b1..60f2053b1 100755
--- a/plugins/apps/commands
+++ b/plugins/apps/commands
@@ -11,6 +11,7 @@ case "$1" in
     apps:create <app>, Create a new app
     apps:destroy <app>, Permanently destroy an app
     apps:rename <old-app> <new-app>, Rename an app
+    apps:report [<app>] [<flag>], Display report about an app
 help_content
     }