Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/falcosuessgott/golang-cli-template
A general purpose golang CLI template for Github and Gitlab
https://github.com/falcosuessgott/golang-cli-template
github gitlab go golang template
Last synced: 6 days ago
JSON representation
A general purpose golang CLI template for Github and Gitlab
- Host: GitHub
- URL: https://github.com/falcosuessgott/golang-cli-template
- Owner: FalcoSuessgott
- License: mit
- Created: 2021-04-25T19:36:58.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-09-10T09:02:26.000Z (4 months ago)
- Last Synced: 2024-12-13T17:49:12.783Z (18 days ago)
- Topics: github, gitlab, go, golang, template
- Language: Shell
- Homepage: https://falcosuessgott.github.io/golang-cli-template/
- Size: 374 KB
- Stars: 62
- Watchers: 3
- Forks: 13
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# golang-cli-template
A general purpose project template for golang CLI applications
This template serves as a starting point for golang commandline applications it is based on golang projects that I consider high quality and various other useful blog posts that helped me understanding golang better.
# Table of Contents
* [golang-cli-template](#golang-cli-template)
* [Features](#features)
* [Project Layout](#project-layout)
* [How to use this template](#how-to-use-this-template)
* [Demo Application](#demo-application)
* [Makefile Targets](#makefile-targets)
* [Contribute](#contribute)
# Features
- [goreleaser](https://goreleaser.com/) with `deb.` and `.rpm` packer and container (`docker.hub` and `ghcr.io`) releasing including `manpages` and `shell completions` and grouped Changelog generation.
- [golangci-lint](https://golangci-lint.run/) for linting and formatting
- [Github Actions](.github/worflows) Stages (Lint, Test (`windows`, `linux`, `mac-os`), Build, Release)
- [Gitlab CI](.gitlab-ci.yml) Configuration (Lint, Test, Build, Release)
- [cobra](https://cobra.dev/) example setup including tests
- [Makefile](Makefile) - with various useful targets and documentation (see Makefile Targets)
- [Github Pages](_config.yml) using [jekyll-theme-minimal](https://github.com/pages-themes/minimal) (checkout [https://falcosuessgott.github.io/golang-cli-template/](https://falcosuessgott.github.io/golang-cli-template/))
- Useful `README.md` badges
- [pre-commit-hooks](https://pre-commit.com/) for formatting and validating code before committing
# Project Layout
* [assets/](https://pkg.go.dev/github.com/FalcoSuessgott/golang-cli-template/assets) => docs, images, etc
* [cmd/](https://pkg.go.dev/github.com/FalcoSuessgott/golang-cli-template/cmd) => commandline configurartions (flags, subcommands)
* [pkg/](https://pkg.go.dev/github.com/FalcoSuessgott/golang-cli-template/pkg) => packages that are okay to import for other projects
* [internal/](https://pkg.go.dev/github.com/FalcoSuessgott/golang-cli-template/pkg) => packages that are only for project internal purposes
- [`tools/`](tools/) => for automatically shipping all required dependencies when running `go get` (or `make bootstrap`) such as `golang-ci-lint` (see: https://github.com/golang/go/wiki/Modules#how-can-i-track-tool-dependencies-for-a-module)
)
- [`scripts/`](scripts/) => build scripts
# How to use this template
```sh
bash <(curl -s https://raw.githubusercontent.com/FalcoSuessgott/golang-cli-template/master/install.sh)
```
In order to make the CI work you will need to have the following Secrets in your repository defined:
Repository -> Settings -> Secrets & variables -> `CODECOV_TOKEN`, `DOCKERHUB_TOKEN` & `DOCKERHUB_USERNAME`
# Demo Application
```sh
$> golang-cli-template -h
golang-cli project template demo application
Usage:
golang-cli-template [flags]
golang-cli-template [command]
Available Commands:
completion Generate the autocompletion script for the specified shell
example example subcommand which adds or multiplies two given integers
help Help about any command
version golang-cli-template version
Flags:
-h, --help help for golang-cli-template
Use "golang-cli-template [command] --help" for more information about a command.
```
```sh
$> golang-cli-template example 2 5 --add
7
$> golang-cli-template example 2 5 --multiply
10
```
# Makefile Targets
```sh
$> make
bootstrap install build deps
build build golang binary
clean clean up environment
cover display test coverage
docker-build dockerize golang application
fmt format go files
help list makefile targets
install install golang binary
lint lint go files
pre-commit run pre-commit hooks
run run the app
test display test coverage
```
# Contribute
If you find issues in that setup or have some nice features / improvements, I would welcome an issue or a PR :)