cobra-cmd

command module

v0.0.0-...-7ca728d Latest Latest Go to latest Published: Sep 18, 2022 License: MIT Imports: 1 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/cybersamx/go-recipes

README ¶

Configurations Loading using Viper and PFlag

An example of using the viper and cobra packages to build a cli program.

The program takes in environment variables, command, command parameters, and pflags with the following pattern.

ENV_NAME=ENV_VALUE APPNAME COMMAND ARG --PFLAG

Setup

Build the program.
```
$ make
```

Run the program

$ # Run the ./cobra-cmd binary - see section Outputs
$ #
$ bin/cobra-cmd
$ # Run the program with help subcommand, we get a help screen with the short descriptor of all commands and flags.
$ bin/cobra-cmd help

Outputs

<<<<<<< Updated upstream

Command Execution	Output
`./cobra-cmd`	Output from the root command.
`./cobra-cmd help`	A help screen with the short descriptor of all commands and flags.
`./cobra-cmd run help`	A help screen for the run subcommand. The long description will be used.
`./cobra-cmd run arg`	Output from the run command, which shows default value of format flag ie. yaml
`./cobra-cmd run arg --format json`	Output from the run command, which shows passed param value of format flag ie. json
`./cobra-cmd run arg -f json`	Output from the run command, which shows passed param value of f (short) flag ie. json
`CYBER_FORMAT=csv ./cobra-cmd run arg`	Output from the run command, which shows the environment variable for format ie. csv
`CYBER_FORMAT=csv ./cobra-cmd run arg --format json`	Output from the run command, if both env and flag variables are present, flag variable takes precedence

=======

Command Executed
`./cobra-cmd`
`./cobra-cmd help`
`./cobra-cmd run help`
`./cobra-cmd run arg`
`./cobra-cmd run arg --format json`
`./cobra-cmd run arg -f json`
`CYBER_FORMAT=csv ./cobra-cmd run arg`
`CYBER_FORMAT=csv ./cobra-cmd run arg --format json`

Stashed changes

Reference and Credits

Documentation ¶

There is no documentation for this package.

Source Files ¶

View all Source files

main.go

Directories ¶

Path	Synopsis
commands

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