feat: make relay flag description more clear

SpatiumPortae · Feb 23, 2023 · 7af990a · 7af990a
1 parent a095d42
commit 7af990a
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 2 deletions.
diff --git a/cmd/portal/receive.go b/cmd/portal/receive.go
@@ -18,8 +18,14 @@ import (
 
 // Setup flags.
 func init() {
+	// Add subcommand flags (dummy default values as default values are handled through viper)
+	desc := `Address of relay server. Can be provided as,
+  - ipv4: 127.0.0.1:8080
+  - ipv6: [::1]:8080
+  - domain: somedomain.com
+  `
+	receiveCmd.Flags().StringP("relay", "r", "", desc)
 	// Add subcommand flags (dummy default values as default values are handled through viper).
-	receiveCmd.Flags().StringP("relay", "r", "", "address of the relay server")
 }
 
 // ------------------------------------------------------ Command ------------------------------------------------------

diff --git a/cmd/portal/send.go b/cmd/portal/send.go
@@ -15,7 +15,12 @@ import (
 // Set flags.
 func init() {
 	// Add subcommand flags (dummy default values as default values are handled through viper)
-	sendCmd.Flags().StringP("relay", "r", "", "Address of the relay server ()")
+	desc := `Address of relay server. Can be provided as,
+  - ipv4: 127.0.0.1:8080
+  - ipv6: [::1]:8080
+  - domain: somedomain.com
+  `
+	sendCmd.Flags().StringP("relay", "r", "", desc)
 }
 
 // ------------------------------------------------------ Command ------------------------------------------------------