Add --list flag to config command to list all available configuration keys

CHANGELOG.md

@@ -7,6 +7,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## [Unreleased]
 ### Added
 - `config` command to get and set configuration options.
+  - `-l, --list` flag to list all available configuration keys.
 - `endpoint list|ls` command to print the endpoints list as a table.
   - `--format` flag to format output using a Go template.
 - `stack list|ls` command to print the stacks list as a table.

Dockerfile

@@ -3,6 +3,7 @@ FROM alpine
 ENV PSU_AUTHENTICATION_PASSWORD="" \
   PSU_AUTHENTICATION_USER="" \
   PSU_CONFIG="" \
+  PSU_CONFIG_LIST="" \
   PSU_CONNECTION_INSECURE="" \
   PSU_CONNECTION_TIMEOUT="" \
   PSU_CONNECTION_URL="" \

cmd/config.go

@@ -8,6 +8,7 @@ import (
 	"github.com/spf13/viper"
 	"log"
 	"os"
+	"sort"
 )
 
 // configCmd represents the config command
@@ -15,63 +16,75 @@ var configCmd = &cobra.Command{
 	Use:   "config KEY [VALUE]",
 	Short: "Get and set configuration options",
 	Example: "psu config user admin",
-	Args:    cobra.RangeArgs(1, 2),
 	Run: func(cmd *cobra.Command, args []string) {
-		// Check if it's a valid key
-		var keyExists bool
-		for _, key := range viper.AllKeys() {
-			if key == args[0] {
-				keyExists = true
-				break
+		if viper.GetBool("config.list") {
+			// List config keys
+			keys := viper.AllKeys()
+			sort.Slice(keys, func(i, j int) bool {
+				return keys[i] < keys[j]
+			})
+			for _, key := range keys {
+				fmt.Println(key)
 			}
-		}
-		if !keyExists {
-			log.Fatalf("Unkonwn configuration key \"%s\"", args[0])
-		}
-
-		// Create new viper
-		commandViper := viper.New()
-
-		// Set config file name
-		var configFile string
-		if viper.ConfigFileUsed() != "" {
-			// Use config file from viper
-			configFile = viper.ConfigFileUsed()
 		} else {
-			// Find home directory
-			home, err := homedir.Dir()
-			if err != nil {
-				fmt.Println(err)
-				os.Exit(1)
-			}
+			if len(args) >= 1 {
+				// Check if it's a valid key
+				var keyExists bool
+				for _, key := range viper.AllKeys() {
+					if key == args[0] {
+						keyExists = true
+						break
+					}
+				}
+				if !keyExists {
+					log.Fatalf("Unkonwn configuration key \"%s\"", args[0])
+				}
 
-			// Use $HOME/.psu.yaml
-			configFile = fmt.Sprintf("%s%s.psu.yaml", home, string(os.PathSeparator))
-		}
-		commandViper.SetConfigFile(configFile)
+				// Create new viper
+				commandViper := viper.New()
 
-		// Read config from file
-		if configReadingErr := commandViper.ReadInConfig(); configReadingErr != nil {
-			common.PrintVerbose(fmt.Sprintf("Could not read configuration from \"%s\". Expect all configuration values to be unset.", configFile))
-		}
+				// Set config file name
+				var configFile string
+				if viper.ConfigFileUsed() != "" {
+					// Use config file from viper
+					configFile = viper.ConfigFileUsed()
+				} else {
+					// Find home directory
+					home, err := homedir.Dir()
+					if err != nil {
+						fmt.Println(err)
+						os.Exit(1)
+					}
 
-		if len(args) == 1 {
-			// Get config
-			fmt.Println(commandViper.Get(args[0]))
-		} else {
-			// Set config
-			commandViper.Set(args[0], args[1])
+					// Use $HOME/.psu.yaml
+					configFile = fmt.Sprintf("%s%s.psu.yaml", home, string(os.PathSeparator))
+				}
+				commandViper.SetConfigFile(configFile)
 
-			// Make sure the config file exists
-			_, fileCreationErr := os.Create(configFile)
-			if fileCreationErr != nil {
-				common.CheckError(fileCreationErr)
-			}
+				// Read config from file
+				if configReadingErr := commandViper.ReadInConfig(); configReadingErr != nil {
+					common.PrintVerbose(fmt.Sprintf("Could not read configuration from \"%s\". Expect all configuration values to be unset.", configFile))
+				}
 
-			// Write te config file
-			configWritingErr := commandViper.WriteConfig()
-			if configWritingErr != nil {
-				common.CheckError(configWritingErr)
+				if len(args) == 1 {
+					// Get config
+					fmt.Println(commandViper.Get(args[0]))
+				} else {
+					// Set config
+					commandViper.Set(args[0], args[1])
+
+					// Make sure the config file exists
+					_, fileCreationErr := os.Create(configFile)
+					if fileCreationErr != nil {
+						common.CheckError(fileCreationErr)
+					}
+
+					// Write te config file
+					configWritingErr := commandViper.WriteConfig()
+					if configWritingErr != nil {
+						common.CheckError(configWritingErr)
+					}
+				}
 			}
 		}
 	},
@@ -79,4 +92,7 @@ var configCmd = &cobra.Command{
 
 func init() {
 	rootCmd.AddCommand(configCmd)
+
+	configCmd.Flags().BoolP("list", "l", false, "list all config keys")
+	viper.BindPFlag("config.list", configCmd.Flags().Lookup("list"))
 }