cli

package
v0.0.0-...-24e03d9 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 9, 2021 License: MIT Imports: 11 Imported by: 1

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func InitConfig

func InitConfig(cmd *cobra.Command, a *app.App, defaultConfigName string, cfgFile string) error

initConfig reads in config file and ENV variables if set. This code largely taken from https://github.com/carolynvs/stingoftheviper

MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Types

type EnumParam

type EnumParam struct {
	// contains filtered or unexported fields
}

Example implementation of an "enum" style parameter with limited valid values

func (*EnumParam) Set

func (a *EnumParam) Set(s string) error

func (*EnumParam) String

func (a *EnumParam) String() string

func (*EnumParam) Type

func (a *EnumParam) Type() string

type ExampleCommand

type ExampleCommand struct {
	App *app.App
}

func (*ExampleCommand) Command

func (c *ExampleCommand) Command() *cobra.Command

an example command that takes a subcommand

type ExampleSubCommand

type ExampleSubCommand struct {
	App *app.App
	// contains filtered or unexported fields
}

func (*ExampleSubCommand) Command

func (c *ExampleSubCommand) Command() *cobra.Command

An example subcommand with positional and flag arguments

type InitCommand

type InitCommand struct {
	App *app.App
}

func (*InitCommand) Command

func (c *InitCommand) Command() *cobra.Command

A command to initialize all configuration, database and eny other similar things for the application. If not relevant doesn't need to exist

type RootCommand

type RootCommand struct {
	App               *app.App
	DefaultConfigName string
	DefaultLogLevel   string
}

func (*RootCommand) Command

func (c *RootCommand) Command() *cobra.Command

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL