github.com/khulnasoft/cli@v0.0.0-20240402070845-01bcad7beefa/cli-plugins/manager/metadata.go (about)

     1  package manager
     2  
     3  const (
     4  	// NamePrefix is the prefix required on all plugin binary names
     5  	NamePrefix = "docker-"
     6  
     7  	// MetadataSubcommandName is the name of the plugin subcommand
     8  	// which must be supported by every plugin and returns the
     9  	// plugin metadata.
    10  	MetadataSubcommandName = "docker-cli-plugin-metadata"
    11  
    12  	// HookSubcommandName is the name of the plugin subcommand
    13  	// which must be implemented by plugins declaring support
    14  	// for hooks in their metadata.
    15  	HookSubcommandName = "docker-cli-plugin-hooks"
    16  )
    17  
    18  // Metadata provided by the plugin.
    19  type Metadata struct {
    20  	// SchemaVersion describes the version of this struct. Mandatory, must be "0.1.0"
    21  	SchemaVersion string `json:",omitempty"`
    22  	// Vendor is the name of the plugin vendor. Mandatory
    23  	Vendor string `json:",omitempty"`
    24  	// Version is the optional version of this plugin.
    25  	Version string `json:",omitempty"`
    26  	// ShortDescription should be suitable for a single line help message.
    27  	ShortDescription string `json:",omitempty"`
    28  	// URL is a pointer to the plugin's homepage.
    29  	URL string `json:",omitempty"`
    30  }