This is a Golang CLI skeleton project that clones itself to provide initial boilerplate that wires up Cobra, Viper and a logging system, an initial version command, along with Makefile, README.MD, and LICENSE files to bootstrap a new project. After the project is generated, a local git repository is initialized along with a first commit.
The generated project will accept its configuration from CLI arguments or any source supported by Viper.
This project includes a Makefile with targets to build the following architectures:
- x86
- x86_64
- ARM
- ARM_64
The following clone command results in a new directory being created one level up ../my-new-app that contains the files included in this skeleton project, with import statements using bitbucket.org/myorg/my-new-app
# Create new project
CLONE_HOST=bitbucket.org CLONE_OWNER=myorg CLONE_APP_NAME=my-new-app make clone
# Try it out ...
cd ../go-my-new-app
make
./my-new-app version --debug
# Result:
Starting logger in debug mode...
config-dir: /etc/my-new-app
data-dir: /home/jhahn/sources/go-my-new-app/db
debug: true
home: /home/jhahn/sources/go-my-new-app
log-dir: ./logs
Name: my-new-app
Version: 0.0.0-alpha.1
Repository: github.com
Package: go-my-new-app
Git Branch: master
Git Tag:
Git Hash: c09670bbeaba23ac0d955286d0b4829d66c5f8dd
Build User: jhahn
Build Date: 2024-06-17_19:58:48
The skeleton project provides initial boilerplate that wires up Cobra, Viper and a logging system, an initial version command, and Makefile, README.MD, and LICENSE files.
Viper is initialized to read config.yaml from the following locations, along with the directory specified by the --config-dir CLI option.
- ./config.yaml
- /etc/{CLONE_APP_NAME}/config.yaml
- $HOME/.{CLONE_APP_NAME}/config.yaml
The following code is used to initialize Cobra:
viper.SetConfigName("config")
viper.SetConfigType("yaml")
viper.AddConfigPath(app.ConfigDir)
viper.AddConfigPath(fmt.Sprintf("/etc/%s/", Name))
viper.AddConfigPath(fmt.Sprintf("$HOME/.%s/", Name))
viper.AddConfigPath(".")
The included Makefile embeds git and build information into the built binary. The version command shows the application name, version, and build information.
The skeleton project includes support for a --debug flag that outputs the Viper configuration to the console and puts the logging system into "debug mode" so logger.Debug statements are sent to the log file and stdout.
The generated skeleton project includes a semantic versioning file in alignment with the Golang Module version number intended for use by your favorite CI/CD system.
The logging system sends logs to stdout and the directory specified by the --log-dir CLI option, or log-dir configuration option set.