improve documentation around stdout/stderr logging

hashicorp · Apr 5, 2024 · 388f7bf · 388f7bf
1 parent 160945f
commit 388f7bf
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -108,8 +108,10 @@ Usage: hc-install install [options] -version <version> <product>
   This command installs a HashiCorp product.
   Options:
     -version  [REQUIRED] Version of product to install.
-    -path     Path to directory where the product will be installed. Defaults
-              to current working directory.
+    -path     Path to directory where the product will be installed.
+              Defaults to current working directory.
+    -log-file Path to file where logs will be written. /dev/stdout
+              or /dev/stderr can be used to log to STDOUT/STDERR.
 ```
 ```sh
 hc-install install -version 1.3.7 terraform

diff --git a/cmd/hc-install/cmd_install.go b/cmd/hc-install/cmd_install.go
@@ -39,9 +39,10 @@ Usage: hc-install install [options] -version <version> <product>
   This command installs a HashiCorp product.
   Options:
     -version  [REQUIRED] Version of product to install.
-    -path     Path to directory where the product will be installed. Defaults
-              to current working directory.
-    -log-file Path to file where logs will be written
+    -path     Path to directory where the product will be installed.
+              Defaults to current working directory.
+    -log-file Path to file where logs will be written. /dev/stdout
+              or /dev/stderr can be used to log to STDOUT/STDERR.
 `
 	return strings.TrimSpace(helpText)
 }