feat: Add examples to --help output for remaining "get APPNAME" (argo…

…proj#15862) * feat: Add examples to --help output for get APPNAME Signed-off-by: Ratan Gulati <[email protected]> * feat: Add examples to --help output for get APPNAME Signed-off-by: Ratan Gulati <[email protected]> * Update app.go Signed-off-by: Ratan Gulati <[email protected]> * Update argocd_app_get.md Signed-off-by: Ratan Gulati <[email protected]> * Update argocd_app_get.md Signed-off-by: Ratan Gulati <[email protected]> * updated app.go Signed-off-by: Ratan Gulati <[email protected]> * Update app.go Signed-off-by: Ratan Gulati <[email protected]> * Update argocd_app_get.md Signed-off-by: Ratan Gulati <[email protected]> * Update app.go Signed-off-by: Ratan Gulati <[email protected]> * docs: clarify health inheritance (argoproj#15799) * docs: resource health inheritance Signed-off-by: Michael Crenshaw <[email protected]> * write more better Signed-off-by: Michael Crenshaw <[email protected]> --------- Signed-off-by: Michael Crenshaw <[email protected]> Signed-off-by: Ratan Gulati <[email protected]> * updated file Signed-off-by: Ratan Gulati <[email protected]> * Update app.go Signed-off-by: Ratan Gulati <[email protected]> * updated get-APPNAME Signed-off-by: Ratan Gulati <[email protected]> * updated get-APPNAME Signed-off-by: Ratan Gulati <[email protected]> --------- Signed-off-by: Ratan Gulati <[email protected]> Signed-off-by: Michael Crenshaw <[email protected]> Co-authored-by: Michael Crenshaw <[email protected]>
tesla59 · Dec 16, 2023 · 1e651f4 · 1e651f4
1 parent 306170a
commit 1e651f4
Show file tree

Hide file tree

Showing 2 changed files with 60 additions and 0 deletions.
diff --git a/cmd/argocd/commands/app.go b/cmd/argocd/commands/app.go
@@ -318,6 +318,35 @@ func NewApplicationGetCommand(clientOpts *argocdclient.ClientOptions) *cobra.Com
 	var command = &cobra.Command{
 		Use:   "get APPNAME",
 		Short: "Get application details",
+		Example: templates.Examples(`  
+  # Get basic details about the application "my-app" in wide format
+  argocd app get my-app -o wide
+
+  # Get detailed information about the application "my-app" in YAML format
+  argocd app get my-app -o yaml
+
+  # Get details of the application "my-app" in JSON format
+  argocd get my-app -o json
+
+  # Get application details and include information about the current operation
+  argocd app get my-app --show-operation
+
+  # Show application parameters and overrides
+  argocd app get my-app --show-params
+
+  # Refresh application data when retrieving
+  argocd app get my-app --refresh
+
+  # Perform a hard refresh, including refreshing application data and target manifests cache
+  argocd app get my-app --hard-refresh
+
+  # Get application details and display them in a tree format
+  argocd app get my-app --output tree
+  
+  # Get application details and display them in a detailed tree format
+  argocd app get my-app --output tree=detailed
+  		`),
+
 		Run: func(c *cobra.Command, args []string) {
 			ctx := c.Context()
 			if len(args) == 0 {

diff --git a/docs/user-guide/commands/argocd_app_get.md b/docs/user-guide/commands/argocd_app_get.md
@@ -8,6 +8,37 @@ Get application details
 argocd app get APPNAME [flags]
 ```
 
+### Examples
+
+```
+  # Get basic details about the application "my-app" in wide format
+  argocd app get my-app -o wide
+  
+  # Get detailed information about the application "my-app" in YAML format
+  argocd app get my-app -o yaml
+  
+  # Get details of the application "my-app" in JSON format
+  argocd get my-app -o json
+  
+  # Get application details and include information about the current operation
+  argocd app get my-app --show-operation
+  
+  # Show application parameters and overrides
+  argocd app get my-app --show-params
+  
+  # Refresh application data when retrieving
+  argocd app get my-app --refresh
+  
+  # Perform a hard refresh, including refreshing application data and target manifests cache
+  argocd app get my-app --hard-refresh
+  
+  # Get application details and display them in a tree format
+  argocd app get my-app --output tree
+  
+  # Get application details and display them in a detailed tree format
+  argocd app get my-app --output tree=detailed
+```
+
 ### Options
 
 ```