README
¶
CLI Package
The CLI package provides a CLI interface for Gofer used to interact and manipulate the Gofer service. It's written with Cobra. It also serves as the entrypoint for the app in general since we run the application by simply calling it from the CLI.
The most confusing part of this package is how global flags are handled in relation to configuration. The intention for the global flags is that they are able to overwrite some of the main configurations of the CLI at the user's convenience.
- First we start out by adding a new PersistentGlobalFlag to the
RootCmdstruct. This tells the CLI that it should support a new global flag. - We then define the global variable in the
configpackage, this includes the variable in the structure that all CLI commands read from. - We then define it's default value(if any) in the related
Default<>Configfunction. - This gives us the ability to call the Init<>Config function which first reads from the configuration file(if found), and then the environment(and overwrites in that order if duplicate keys are found).
- Lastly we call our global flag and if the user has set it we overwrite whatever is current in the state config.
This makes it so that each command line instance can call InitState and have a proper hierarchy of variable overwriting.
This is in addition to the configuration hierarchy that is also created. Explained below:
In order to implement proper configuration management for both the API and the CLI we follow 12-factor. The gist is that environment variables are king, but there are some nuance that this package iterates on.
The final structure for the configuration hierarchy is: file -> env -> flags. Each overrides the last step if there are any conflicting keys.
That is to say that if a user runs a command with a --token flag. That flag will replace the GOFER_TOKEN environment variable
if one was mentioned and if there wasn't then it will replace the gofer_token configuration file setting if that existed.
Documentation
¶
Overview ¶
Package cli controls the main user entry point into both the API and interacting with it. It provides not only administrators an easy way to interact with gofer, but is the main entry point for how non-UI users interact with Gofer.
Index ¶
Constants ¶
This section is empty.
Variables ¶
var RootCmd = &cobra.Command{ Use: "gofer", Short: "Gofer is a distributed, continuous thing do-er.", Long: `Gofer is a distributed, continuous thing do-er. It uses a similar model to [concourse](https://concourse-ci.org/), leveraging the docker container as a key mechanism to run short-lived workloads. The benefits of this is simplicity. No foreign agents, no cluster setup, just run containers. Read more at https://clintjedwards.com/gofer. ## Configuration All global flags have an equivalent environment variable you can set instead of the flag. If both are set, the flag will have precedence. Read more about CLI configuration here: https://clintjedwards.com/gofer/cli/configuration.html. ### Environment Variables supported: ` + strings.Join(config.GetCLIEnvVars(), "\n"), Version: " ", PersistentPreRun: func(cmd *cobra.Command, _ []string) { cl.InitState(cmd) }, }
RootCmd is the base of the cli
Functions ¶
Types ¶
This section is empty.
Source Files
Directories