github.1git.de/docker/cli@v26.1.3+incompatible/cli/command/config/ls.go (about)

     1  package config
     2  
     3  import (
     4  	"context"
     5  	"sort"
     6  
     7  	"github.com/docker/cli/cli"
     8  	"github.com/docker/cli/cli/command"
     9  	"github.com/docker/cli/cli/command/completion"
    10  	"github.com/docker/cli/cli/command/formatter"
    11  	flagsHelper "github.com/docker/cli/cli/flags"
    12  	"github.com/docker/cli/opts"
    13  	"github.com/docker/docker/api/types"
    14  	"github.com/fvbommel/sortorder"
    15  	"github.com/spf13/cobra"
    16  )
    17  
    18  // ListOptions contains options for the docker config ls command.
    19  type ListOptions struct {
    20  	Quiet  bool
    21  	Format string
    22  	Filter opts.FilterOpt
    23  }
    24  
    25  func newConfigListCommand(dockerCli command.Cli) *cobra.Command {
    26  	listOpts := ListOptions{Filter: opts.NewFilterOpt()}
    27  
    28  	cmd := &cobra.Command{
    29  		Use:     "ls [OPTIONS]",
    30  		Aliases: []string{"list"},
    31  		Short:   "List configs",
    32  		Args:    cli.NoArgs,
    33  		RunE: func(cmd *cobra.Command, args []string) error {
    34  			return RunConfigList(cmd.Context(), dockerCli, listOpts)
    35  		},
    36  		ValidArgsFunction: completion.NoComplete,
    37  	}
    38  
    39  	flags := cmd.Flags()
    40  	flags.BoolVarP(&listOpts.Quiet, "quiet", "q", false, "Only display IDs")
    41  	flags.StringVar(&listOpts.Format, "format", "", flagsHelper.FormatHelp)
    42  	flags.VarP(&listOpts.Filter, "filter", "f", "Filter output based on conditions provided")
    43  
    44  	return cmd
    45  }
    46  
    47  // RunConfigList lists Swarm configs.
    48  func RunConfigList(ctx context.Context, dockerCli command.Cli, options ListOptions) error {
    49  	client := dockerCli.Client()
    50  
    51  	configs, err := client.ConfigList(ctx, types.ConfigListOptions{Filters: options.Filter.Value()})
    52  	if err != nil {
    53  		return err
    54  	}
    55  
    56  	format := options.Format
    57  	if len(format) == 0 {
    58  		if len(dockerCli.ConfigFile().ConfigFormat) > 0 && !options.Quiet {
    59  			format = dockerCli.ConfigFile().ConfigFormat
    60  		} else {
    61  			format = formatter.TableFormatKey
    62  		}
    63  	}
    64  
    65  	sort.Slice(configs, func(i, j int) bool {
    66  		return sortorder.NaturalLess(configs[i].Spec.Name, configs[j].Spec.Name)
    67  	})
    68  
    69  	configCtx := formatter.Context{
    70  		Output: dockerCli.Out(),
    71  		Format: NewFormat(format, options.Quiet),
    72  	}
    73  	return FormatWrite(configCtx, configs)
    74  }