sigs.k8s.io/kubebuilder/v3@v3.14.0/pkg/plugin/metadata.go (about)

     1  /*
     2  Copyright 2022 The Kubernetes Authors.
     3  
     4  Licensed under the Apache License, Version 2.0 (the "License");
     5  you may not use this file except in compliance with the License.
     6  You may obtain a copy of the License at
     7  
     8      http://www.apache.org/licenses/LICENSE-2.0
     9  
    10  Unless required by applicable law or agreed to in writing, software
    11  distributed under the License is distributed on an "AS IS" BASIS,
    12  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    13  See the License for the specific language governing permissions and
    14  limitations under the License.
    15  */
    16  
    17  package plugin
    18  
    19  // CLIMetadata is the runtime meta-data of the CLI
    20  type CLIMetadata struct {
    21  	// CommandName is the root command name.
    22  	CommandName string
    23  }
    24  
    25  // SubcommandMetadata is the runtime meta-data for a subcommand
    26  type SubcommandMetadata struct {
    27  	// Description is a description of what this command does. It is used to display help.
    28  	Description string
    29  	// Examples are one or more examples of the command-line usage of this command. It is used to display help.
    30  	Examples string
    31  }