From 1d2d42276b6acc8cba062da9536e8acae69034be Mon Sep 17 00:00:00 2001

From: Link Dupont <link@sub-pop.net>

Date: Wed, 30 Jun 2021 14:47:00 -0400

Subject: [PATCH 2/2] feat: Include Description in help output

Fixes ESSNTL-838

Signed-off-by: Link Dupont <link@sub-pop.net>

---

 cmd/ygg/main.go | 8 ++++++++

 1 file changed, 8 insertions(+)

diff --git a/cmd/ygg/main.go b/cmd/ygg/main.go

index f5c5c47..5524347 100644

--- a/cmd/ygg/main.go

+++ b/cmd/ygg/main.go

@@ -28,6 +28,14 @@ func main() {

 	app.Name = yggdrasil.ShortName

 	app.Version = yggdrasil.Version

 	app.Usage = "control the system's connection to " + yggdrasil.Provider

+	app.Description = "The " + app.Name + " command controls the system's connection to " + yggdrasil.Provider + ".\n\n" +

+		"To connect the system using an activation key:\n" +

+		"\t" + app.Name + " connect --organization ID --activation-key KEY\n\n" +

+		"To connect the system using a username and password:\n" +

+		"\t" + app.Name + " connect --username USERNAME --password PASSWORD\n\n" +

+		"To disconnect the system:\n" +

+		"\t" + app.Name + " disconnect\n\n" +

+		"Run '" + app.Name + " command --help' for more details."

 	log.SetFlags(0)

 	log.SetPrefix("")

-- 

2.31.1