Go

Go toolchain commands for building, testing, and managing modules. Format code, run benchmarks, and handle dependencies.

69 commands

Browse by Topic

Getting Started

Quick setup and installation

3commands

Build

Compilation & cross-compilation

12commands

Modules

Module management

12commands

Test

Testing & benchmarks

13commands

Quality

Vet, fmt, lint

7commands

Environment

Environment variables

6commands

Workspaces

Multi-module workspaces

5commands

Install

Installing tools

4commands

Run

Running & docs

7commands

Install Go (macOS)

$ brew install go

Install Go using Homebrew on macOS

Check Go version

$ go version

Display installed Go version

Initialize Go module

$ go mod init myproject

Initialize a new Go module in the current directory

Build project

$ go build

Compile packages and dependencies in current directory.

Build with output name

$ go build -o myapp

Compile and specify output binary name.

Build with verbose

$ go build -v

Verbose output showing compiled packages.

Build for Linux

$ GOOS=linux GOARCH=amd64 go build -o myapp-linux

Cross-compile for Linux AMD64.

Build for Windows

$ GOOS=windows GOARCH=amd64 go build -o myapp.exe

Cross-compile for Windows AMD64.

Build for macOS ARM

$ GOOS=darwin GOARCH=arm64 go build -o myapp-mac

Cross-compile for Apple Silicon.

Build with race detector

$ go build -race

Enable data race detection (slower but safer).

Build stripped binary

$ go build -ldflags="-w -s"

Strip debug info for smaller binary size.

Build with version info

$ go build -ldflags="-X main.version=v1.0.0"

Inject version at build time via ldflags.

Build with trimpath

$ go build -trimpath

Remove file system paths from binary for reproducibility.

Production build

$ CGO_ENABLED=0 go build -ldflags="-w -s" -trimpath -o myapp

Static binary with no CGO, stripped debug info.

Build with tags

$ go build -tags integration

Include files with matching build tags.

Initialize module

$ go mod init github.com/user/project

Create new Go module (generates go.mod).

Tidy dependencies

$ go mod tidy

Add missing and remove unused dependencies.

Download dependencies

$ go mod download

Download modules to local cache.

Vendor dependencies

$ go mod vendor

Copy dependencies to vendor directory.

Verify dependencies

$ go mod verify

Verify dependencies match go.sum checksums.

Show dependency graph

$ go mod graph

Print module dependency graph.

Explain why needed

$ go mod why golang.org/x/sync

Explain why a package/module is needed.

Add dependency

$ go get github.com/gin-gonic/gin@latest

Add package to module dependencies.

Add specific version

$ go get github.com/pkg/errors@v0.9.1

Add package at specific version.

Update all dependencies

$ go get -u ./...

Update all dependencies to latest minor/patch.

Edit go.mod (replace)

$ go mod edit -replace=github.com/old/pkg=../local/pkg

Add module replacement for local development.

List all modules

$ go list -m all

List all module dependencies.

Run all tests

$ go test ./...

Run tests in all packages recursively.

Run with verbose

$ go test -v ./...

Verbose output showing all test names.

Run specific test

$ go test -run TestUserLogin ./...

Run only tests matching pattern.

Run with coverage

$ go test -cover ./...

Display coverage percentage.

Generate coverage report

$ go test -coverprofile=coverage.out ./...

Generate coverage profile file.

View coverage in browser

$ go tool cover -html=coverage.out

Open coverage report in browser.

Run with race detector

$ go test -race ./...

Enable race detection during tests.

Disable test caching

$ go test -count=1 ./...

Force re-run tests (bypass cache).

Set test timeout

$ go test -timeout=30s ./...

Set maximum test duration.

Run benchmarks

$ go test -bench=. ./...

Run all benchmarks.

Benchmarks with memory

$ go test -bench=. -benchmem ./...

Show memory allocation statistics.

Fuzz testing

$ go test -fuzz=FuzzParse -fuzztime=30s

Run fuzzing on specific test for 30 seconds.

CPU profiling

$ go test -cpuprofile=cpu.out -bench=.

Generate CPU profile during benchmarks.

Static analysis

$ go vet ./...

Examine code for suspicious constructs.

Format code

$ go fmt ./...

Format all Go files recursively.

Simplify code

$ gofmt -s -w .

Format and simplify code patterns.

Run go fix

$ go fix ./...

Update code to use new APIs after Go upgrade.

Run golangci-lint

$ golangci-lint run

Run comprehensive meta-linter.

Lint with auto-fix

$ golangci-lint run --fix

Auto-fix linting issues where possible.

Run go generate

$ go generate ./...

Run code generators specified in //go:generate.

Show all env vars

$ go env

Display all Go environment variables.

Get specific env var

$ go env GOPATH

Show specific environment variable.

Set env var persistently

$ go env -w GOPROXY=https://proxy.golang.org,direct

Set Go environment variable permanently.

Set private modules

$ go env -w GOPRIVATE=github.com/myorg/*

Configure private modules (bypass proxy).

Disable CGO

$ CGO_ENABLED=0 go build

Build without C bindings for static binary.

Output as JSON

$ go env -json

Show environment as JSON.

Initialize workspace

$ go work init ./module1 ./module2

Create go.work file for multi-module development.

Add module to workspace

$ go work use ./new-module

Add module directory to workspace.

Add all modules recursively

$ go work use -r .

Add all Go modules in subdirectories.

Sync workspace

$ go work sync

Sync workspace dependencies to all modules.

Edit workspace

$ go work edit -replace github.com/old=./local

Add replacement to workspace.

Install tool (latest)

$ go install golang.org/x/tools/cmd/goimports@latest

Install Go tool at latest version.

Install specific version

$ go install github.com/golangci/golangci-lint/cmd/golangci-lint@v1.55.2

Install tool at specific version.

Install from local

$ go install .

Install current package as executable.

List installed

$ ls $(go env GOPATH)/bin

List installed Go binaries.

Run file

$ go run main.go

Compile and run single file.

Run package

$ go run .

Compile and run current package.

Run with race detector

$ go run -race main.go

Run with data race detection enabled.

View package docs

$ go doc fmt

Show documentation for package.

View function docs

$ go doc fmt.Println

Show documentation for specific symbol.

Clean build cache

$ go clean -cache

Clear build cache.

Clean module cache

$ go clean -modcache

Clear module download cache.

Discussion

Loading comments...

Go

Go toolchain commands for building, testing, and managing modules. Format code, run benchmarks, and handle dependencies.

69 commands

Browse by Topic

Getting Started

Quick setup and installation

3commands

Build

Compilation & cross-compilation

12commands

Modules

Module management

12commands

Test

Testing & benchmarks

13commands

Quality

Vet, fmt, lint

7commands

Environment

Environment variables

6commands

Workspaces

Multi-module workspaces

5commands

Install

Installing tools

4commands

Run

Running & docs

7commands

Install Go (macOS)

$ brew install go

Install Go using Homebrew on macOS

Check Go version

$ go version

Display installed Go version

Initialize Go module

$ go mod init myproject

Initialize a new Go module in the current directory

Build project

$ go build

Compile packages and dependencies in current directory.

Build with output name

$ go build -o myapp

Compile and specify output binary name.

Build with verbose

$ go build -v

Verbose output showing compiled packages.

Build for Linux

$ GOOS=linux GOARCH=amd64 go build -o myapp-linux

Cross-compile for Linux AMD64.

Build for Windows

$ GOOS=windows GOARCH=amd64 go build -o myapp.exe

Cross-compile for Windows AMD64.

Build for macOS ARM

$ GOOS=darwin GOARCH=arm64 go build -o myapp-mac

Cross-compile for Apple Silicon.

Build with race detector

$ go build -race

Enable data race detection (slower but safer).

Build stripped binary

$ go build -ldflags="-w -s"

Strip debug info for smaller binary size.

Build with version info

$ go build -ldflags="-X main.version=v1.0.0"

Inject version at build time via ldflags.

Build with trimpath

$ go build -trimpath

Remove file system paths from binary for reproducibility.

Production build

$ CGO_ENABLED=0 go build -ldflags="-w -s" -trimpath -o myapp

Static binary with no CGO, stripped debug info.

Build with tags

$ go build -tags integration

Include files with matching build tags.

Initialize module

$ go mod init github.com/user/project

Create new Go module (generates go.mod).

Tidy dependencies

$ go mod tidy

Add missing and remove unused dependencies.

Download dependencies

$ go mod download

Download modules to local cache.

Vendor dependencies

$ go mod vendor

Copy dependencies to vendor directory.

Verify dependencies

$ go mod verify

Verify dependencies match go.sum checksums.

Show dependency graph

$ go mod graph

Print module dependency graph.

Explain why needed

$ go mod why golang.org/x/sync

Explain why a package/module is needed.

Add dependency

$ go get github.com/gin-gonic/gin@latest

Add package to module dependencies.

Add specific version

$ go get github.com/pkg/errors@v0.9.1

Add package at specific version.

Update all dependencies

$ go get -u ./...

Update all dependencies to latest minor/patch.

Edit go.mod (replace)

$ go mod edit -replace=github.com/old/pkg=../local/pkg

Add module replacement for local development.

List all modules

$ go list -m all

List all module dependencies.

Run all tests

$ go test ./...

Run tests in all packages recursively.

Run with verbose

$ go test -v ./...

Verbose output showing all test names.

Run specific test

$ go test -run TestUserLogin ./...

Run only tests matching pattern.

Run with coverage

$ go test -cover ./...

Display coverage percentage.

Generate coverage report

$ go test -coverprofile=coverage.out ./...

Generate coverage profile file.

View coverage in browser

$ go tool cover -html=coverage.out

Open coverage report in browser.

Run with race detector

$ go test -race ./...

Enable race detection during tests.

Disable test caching

$ go test -count=1 ./...

Force re-run tests (bypass cache).

Set test timeout

$ go test -timeout=30s ./...

Set maximum test duration.

Run benchmarks

$ go test -bench=. ./...

Run all benchmarks.

Benchmarks with memory

$ go test -bench=. -benchmem ./...

Show memory allocation statistics.

Fuzz testing

$ go test -fuzz=FuzzParse -fuzztime=30s

Run fuzzing on specific test for 30 seconds.

CPU profiling

$ go test -cpuprofile=cpu.out -bench=.

Generate CPU profile during benchmarks.

Static analysis

$ go vet ./...

Examine code for suspicious constructs.

Format code

$ go fmt ./...

Format all Go files recursively.

Simplify code

$ gofmt -s -w .

Format and simplify code patterns.

Run go fix

$ go fix ./...

Update code to use new APIs after Go upgrade.

Run golangci-lint

$ golangci-lint run

Run comprehensive meta-linter.

Lint with auto-fix

$ golangci-lint run --fix

Auto-fix linting issues where possible.

Run go generate

$ go generate ./...

Run code generators specified in //go:generate.

Show all env vars

$ go env

Display all Go environment variables.

Get specific env var

$ go env GOPATH

Show specific environment variable.

Set env var persistently

$ go env -w GOPROXY=https://proxy.golang.org,direct

Set Go environment variable permanently.

Set private modules

$ go env -w GOPRIVATE=github.com/myorg/*

Configure private modules (bypass proxy).

Disable CGO

$ CGO_ENABLED=0 go build

Build without C bindings for static binary.

Output as JSON

$ go env -json

Show environment as JSON.

Initialize workspace

$ go work init ./module1 ./module2

Create go.work file for multi-module development.

Add module to workspace

$ go work use ./new-module

Add module directory to workspace.

Add all modules recursively

$ go work use -r .

Add all Go modules in subdirectories.

Sync workspace

$ go work sync

Sync workspace dependencies to all modules.

Edit workspace

$ go work edit -replace github.com/old=./local

Add replacement to workspace.

Install tool (latest)

$ go install golang.org/x/tools/cmd/goimports@latest

Install Go tool at latest version.

Install specific version

$ go install github.com/golangci/golangci-lint/cmd/golangci-lint@v1.55.2

Install tool at specific version.

Install from local

$ go install .

Install current package as executable.

List installed

$ ls $(go env GOPATH)/bin

List installed Go binaries.

Run file

$ go run main.go

Compile and run single file.

Run package

$ go run .

Compile and run current package.

Run with race detector

$ go run -race main.go

Run with data race detection enabled.

View package docs

$ go doc fmt

Show documentation for package.

View function docs

$ go doc fmt.Println

Show documentation for specific symbol.

Clean build cache

$ go clean -cache

Clear build cache.

Clean module cache

$ go clean -modcache

Clear module download cache.

Discussion

Loading comments...