Go Tool
External
Internal
Overview
go is a command line tool with multiple uses: package manager, build tool and test driver. go manage packages in workspaces, query metadata about packages, print documentation, build, format, download, test, etc.
Commands
Help
go help <command>
go help build
build
The build command compiles one or more packages and builds the executable if the package main is among the compiled packages. The tool is sensitive to GOPATH mode. For more details, see:
TO DEPLETE: Go_Commands_-_build
Also see:
Build an Executable with go build
install
go install is similar to go build except that is saves the compiled code as object files locally for each packages instead of discarding it.
The shared flags describe here apply:
If executed from a git workarea, there is underlying git interaction.
Build and Install an Executable with go install
run
The run command compiles the specified packages or files by delegating to go build and then runs the executable. There must be a main for an executable to be generated.
cd $PROJECT_DIR
go run ./src/main/main.go some-arg-1 some-arg-2
The first argument that does not end in .go is assumed to be the beginning of the list of command line arguments of the executable.
The shared flags described here apply:
clean
The shared flags described here apply:
-cache
Clean the build cache:
go clean -cache
-fuzzcache
Clean the fuzz cache:
go clean -fuzzcache
doc
The doc command prints documentation for a package or a package member:
go doc time
go doc time.Since
fmt
The fmt ("format") command formats source code files.
get
The get command downloads packages and installs them. The shared flags described here apply:
list
The list command lists all installed packages. The shared flags described here apply:
test
The test command runs tests. The shared flags described here apply:
For more details, see:
env
The env command prints the effective values of the environment variables relevant to the tool chain.
go env GOOS GOARCH GOPATH
get
The get command retrieve and update packages.
TODO Addison-Wesley The Go Programming Language Section 10.7.2
mod
Initialize a v0 or v1 module:
go mod init example.com/m
Initialize a v2 module:
go mod init example.com/m/v2
Inspect the code, look for module imports, download them and update go.mod.
go mod tidy
TO DEPLETE
Deplete: