cmd

Documentation

Overview

Package cmd

Copyright © 2021 Tonye Jack <jtonye@ymail.com>

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Index

• Variables
• func Execute()
• type Action
• type Input
• type Output

Variables

var AutoDocEnd = "<!-- AUTO-DOC-%s:END -->"

var AutoDocStart = "<!-- AUTO-DOC-%s:START - Do not remove or modify this section -->"

var InputsHeader = "## Inputs"

var OutputsHeader = "## Outputs"

Functions

func Execute

func Execute()

Execute adds all child commands to the root command and sets flags appropriately. This is called by main.main(). It only needs to happen once to the rootCmd.

Types

type Action

type Action struct {
	Inputs  map[string]Input  `yaml:"inputs,omitempty"`
	Outputs map[string]Output `yaml:"outputs,omitempty"`
}

type Input

type Input struct {
	Description string `yaml:"description"`
	Required    bool   `yaml:"required"`
	Default     string `yaml:"default,omitempty"`
}

type Output

type Output struct {
	Description string `yaml:"description"`
	Value       string `yaml:"default,omitempty"`
}