Creating a Go Package

Some quick instructions on how to create a package and a module in Go (GoLang).

• Create a directory for your main package such as example/
• In that directory create a main.go file with a first line of package main
• Initialize the module with go mod init example
• Create a directory for your first package such as special/
• Create a file for you package such as special/thing.go with a first line of package special
• Import the package into main.go as example/special

Your directory of files will look like this.

example/
  main.go
  special/
    thing.go

Your code will look like this.

main.go

package main

import "example/special"

func main() {
	special.Thing()
}

special/thing.go

package special

func Thing() {
	println("Special Thing")
}

Online Packages

If you call your package something like joeldare.com/example instead of example then you can put the package files online and it can be loaded from that URL instead of the local directory. To do that you would change the init command to something like go mod init joeldare.com/example. In that case, your main.go might look like this.

package main

import "joeldare.com/example/special"

func main() {
	special.Thing()
}

It will still load the special package from the special/ directory if it’s there but if not it will look for it online at joeldare.com/example/special.

Joel's Newsletter

Get a monthly digest of what I'm up to.

Subscribe by Email