Add examples to commands

sestrella · Oct 17, 2024 · 5458c20 · 5458c20
1 parent 3ab0d82
commit 5458c20
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 2 deletions.
diff --git a/cmd/exec.go b/cmd/exec.go
@@ -19,6 +19,10 @@ import (
 var execCmd = &cobra.Command{
 	Use:   "exec",
 	Short: "Runs a command remotely on a container",
+	Example: `
+  aws-vault exec <profile> -- iecs exec -m /bin/bash (recommended)
+  env AWS_PROFILE=<profile> iecs exec -m /bin/bash
+  `,
 	RunE: func(cmd *cobra.Command, args []string) error {
 		clusterId, err := cmd.Flags().GetString("cluster")
 		if err != nil {

diff --git a/cmd/root.go b/cmd/root.go
@@ -11,8 +11,8 @@ var rootCmd = &cobra.Command{
 	Short:   "An interactive CLI for ECS",
 	Version: "0.1.0",
 	Example: `
-    aws-vault exec <profile> -- iecs ... (recommended)
-    env AWS_PROFILE=<profile> iecs ...
+  aws-vault exec <profile> -- iecs ... (recommended)
+  env AWS_PROFILE=<profile> iecs ...
   `,
 }