github.com/vmware/govmomi@v0.37.2/govc/cli/register.go (about)

     1  /*
     2  Copyright (c) 2014-2015 VMware, Inc. All Rights Reserved.
     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 cli
    18  
    19  import "os"
    20  
    21  var commands = map[string]Command{}
    22  
    23  var aliases = map[string]string{}
    24  
    25  // hideUnreleased allows commands to be compiled into the govc binary without being registered by default.
    26  // Unreleased commands are omitted from 'govc -h' help text and the generated govc/USAGE.md
    27  // Setting the env var GOVC_SHOW_UNRELEASED=true enables any commands registered as unreleased.
    28  var hideUnreleased = os.Getenv("GOVC_SHOW_UNRELEASED") != "true"
    29  
    30  func ShowUnreleased() bool {
    31  	return !hideUnreleased
    32  }
    33  
    34  func Register(name string, c Command, unreleased ...bool) {
    35  	if len(unreleased) != 0 && unreleased[0] && hideUnreleased {
    36  		return
    37  	}
    38  	commands[name] = c
    39  }
    40  
    41  func Alias(name string, alias string) {
    42  	aliases[alias] = name
    43  }
    44  
    45  func Commands() map[string]Command {
    46  	return commands
    47  }