gopher-init

Scaffold a new Go 1.24+ project.

Arguments

Parse from $ARGUMENTS:

• module-path (required): Go module path (e.g., github.com/org/project)
• --layout (optional): minimal, standard (default), or service

If no arguments provided, ask the user for the module path.

Layouts

minimal

project/
├── go.mod
├── main.go
├── main_test.go
├── Makefile
└── README.md

standard

project/
├── cmd/
│   └── server/
│       └── main.go
├── internal/
│   ├── domain/
│   ├── service/
│   ├── repository/
│   ├── handler/
│   └── config/
├── pkg/
├── migrations/
├── go.mod
├── Makefile
├── .golangci.yml
├── Dockerfile
└── README.md

service

project/
├── cmd/
│   ├── api/
│   │   └── main.go
│   └── worker/
│       └── main.go
├── internal/
│   ├── domain/
│   ├── service/
│   ├── repository/
│   ├── handler/
│   └── config/
├── pkg/
├── migrations/
├── go.mod
├── Makefile
├── .golangci.yml
├── Dockerfile
└── README.md

Steps

1. Pre-flight Check

Check which files and directories from the chosen layout already exist. Track them — subsequent steps will skip existing files rather than overwriting them.

2. Create Directory Structure

Report: "Creating directory structure..."

Create directories based on the chosen layout. Skip directories that already exist.

3. Initialize Module

Report: "Initializing Go module..."

Skip if go.mod already exists.

go mod init <module-path>

Then edit go.mod to set Go 1.24.

For standard and service layouts, add tool directives:

module <module-path>

go 1.24

tool (
    golang.org/x/tools/cmd/goimports
    github.com/golangci/golangci-lint/cmd/golangci-lint
    golang.org/x/vuln/cmd/govulncheck
)

For minimal:

module <module-path>

go 1.24

4. Create main.go

Skip if the target main.go already exists.

For minimal:

package main

import "fmt"

func main() {
	fmt.Println("Hello, World!")
}

For standard and service (cmd/server/main.go or cmd/api/main.go):