A CLI tool to initialize a Go project with customizable default folders and files.
This small utility allows you to start your new project in Go with an already initialized standard folders and default support files such as Makefile, Dockerfile, README.md, LICINSE etc. It creates a git repo as well and tries to open the new project in VS Code by default. (You can change this behaviour by flags in CLI)
Init project structure:
.
└── your_project
├── cmd/
├── internal/
├── pkg/
├── main.go
├── go.mod
├── Dockerfile
├── LICENSE
├── Makefile
├── README.md
├── .env
├── .dockerignore
└── .gitignore- new Generates a new Go porject with default files and folders in the new folder
- init Generates a new Go porject with default files and folders in the path
- config Sets up global configuration for all new generated projects
- help Help about any command
- completion Generates the autocompletion script for the specified shell
- version Gets version info
Default installation to GOPATH/bin folder
go install github.com/ProstoyVadila/goproj@latest!!! Make sure that GOPATH/bin is in your PATH.
Just type goproj in your terminal in your project folder
goprojand answer a few questions:
Another option is to use CLI arguments to make it more in a Go way:
goproj init <your_new_package>
or with
goproj new <your_new_package>This command generates a new project in the new folder. It can resolve folder's name by the entered project's name.
For example, goproj new github.com/bob/mylib generates everything in mylib folder.
You can specify some parameters with optional flags. For example:
goproj init github.com/Bobert/new_app --author Bob -d="My new project" --skip="Dockerfile,.dokerignore,internal/,pkg/"
There is a description of all flags and options:
Flags:
-a, --author string an optional flag to set your name
-d, --description strings an optional flag to set a description of your project
-g, --git an optional flag to define start git initialization or not (default false)
-c, --vscode an optional flag to open the new project in VS Code (default false)
-s, --skip an optional flag to skip exact files and/or folders (add / after folder's name) from the generation.
-h, --help help for init
You can find more information with goproj init --help or goproj new --help commands.
-
go.mod – generates with the entered package name and your version of Go.
-
main.go – an empty file with
package mainandfunc main(). -
.env – an empty env file.
-
LICENSE – The MIT license with your entered name and the current year.
-
Dockerfile – multi-stage build dockerfile setup with your version of Go.
FROM golang:1.22-alpine AS builder
WORKDIR /app
COPY . .
RUN env GOOS=linux CGO_ENABLED=0 go build -ldflags "-w" -o main
FROM alpine:latest
WORKDIR /app
COPY --from=builder /app/main .
COPY .env .
CMD ["/app/main"]- Makefile – a simple Makefile with
run/build/testscommands.
run:
@go run .
build:
@go build -o bin/main
tests:
@go test .
.PHONY: run build tests- .gitignore – a default gitignore template for projects in Go.
# Binaries for programs and plugins
*.exe
*.exe~
*.dll
*.so
*.dylib
# Test binary, built with `go test -c`
*.test
# Output of the go coverage tool, specifically when used with LiteIDE
*.out
# Dependency directories (remove the comment below to include it)
# vendor/
# Go workspace file
go.work- .dockerignore – a default dockerignore template for projects in Go.
# The .dockerignore file excludes files from the container build process.
#
# https://docs.docker.com/engine/reference/builder/#dockerignore-file
# Exclude locally vendored dependencies.
vendor/
# Exclude "build-time" ignore files.
.dockerignore
.gcloudignore
# Exclude git history and configuration.
.gitignore
There are some standart folders for any project in Go:
- cmd
- internal
- pkg
You can set a global configuration for your new projects by command gorpoj config with args in CLI. It will create goproj.config.toml file in ~/.config/goproj folder. And generator will read it every time when you start a new project (additinal args will override config setup for that project)
Just type
goproj configand answer a few questions like in goproj init command.
You can set a global config by providing a file as well. Goproj supports json, yaml and toml file extensions.
For example:
goproj config -f my_config.tomlYou can find examples of config files here
Or you can set it with additional flags like in the gorpoj init mode. For example:
goproj config -a "Bobert Doe" -p "github.com/bobert_doe" --skip="Dockerfile,.dockerignore,internal/,pkg/" --git=false --vscode=falseOr you can set/change a global config manually by creating/changing ~/.config/goproj/goproj.config.toml file (It doesn't exist by default).
This is a list of all flags:
Set up global configuration for all new generated projects to not do it every time
Usage:
config [flags]
Examples:
goproj config -a "Bobert Doe" -s="Dockerfile,.dockerignore,internal/,pkg/" --git=false --vscode=false
Flags:
-a, --author string an optional flag to set author name
-f, --file json an optional flag to set information from yaml file (supprots `json`, `yaml`, `toml`)
-p, --prefix string an optional flag to set repo prefix for your new projects (example: "github.com/<smth>")
-g, --git an optional flag to define start git initialization or not (default false)
-c, --vscode an optional flag to open the new project in VS Code (default false)
-s, --skip an optional flag to skip exact files and/or folders (add / after folder's name) from the generation
-h, --help help for config
You can find them with gorpoj config --help command.
You can check your global config with:
goproj config showThat's it!
Please, enjoy! :)
- an option to set another folders or empty files to generate in the global config.
- an option to choose a license.