Skip to content

Latest commit

 

History

History
171 lines (131 loc) · 4.63 KB

README.md

File metadata and controls

171 lines (131 loc) · 4.63 KB
Raw

goversion

checks pkg.go.dev goreportcard codecov

Easily switch between multiple Go versions.

📌 About

Go supports installing multiple versions simultaneously as separate binaries, such as go (the main version) and go1.18 (an add-on version). This works fine when using go <command> directly, but can be inconvenient when the command is hardcoded in a Makefile or a shell script. The goversion tool solves this by symlinking go1.X.Y to go, so that an add-on version can be used as the main one.

> go version
go version go1.20 darwin/arm64

> goversion use 1.18
1.18 is not installed. Looking for it on go.dev ...
# Downloading ...
Switched to 1.18

> go version
go version go1.18 darwin/arm64

Note

Starting with Go 1.21, the go tool is able to download new SDKs automatically. It's possible to force it to use a specific Go version:

GOTOOLCHAIN=go1.18 go version

If you just need to quickly test something with a different Go version, it is recommended to use this approach, as it does not require installing additional binaries. goversion is still useful for explicit version management.

🚀 Features

  • Install and switch between multiple Go versions
  • List installed Go versions (optionally, all available versions)
  • Remove installed Go versions with a single command
  • Depends only on Go itself
  • Cross-platform: tested on Linux, Windows, macOS

📦 Install

First, add $GOBIN (usually $HOME/go/bin) to your $PATH. Make sure it takes precedence over the location of the main go binary (e.g. /usr/local/go/bin or /opt/homebrew/bin).

Then install goversion with Go...

go install go-simpler.org/goversion@latest

...or download a prebuilt binary from the Releases page.

📋 Usage

Use

Switches the current Go version (will be installed if not exists).

> goversion use 1.18
Switched to 1.18

The special gotip version can be used just like any other.

> goversion use tip
Switched to tip

To switch back to the main version, use the main string.

> goversion use main
Switched to 1.20 (main)

List

Prints the list of installed Go versions. The current version is marked with the * symbol.

> goversion ls
  1.20 (main)
* 1.18

The -a (-all) flag can be used to print also available versions from go.dev.

> goversion ls -all
  tip     (not installed)
  1.20.14 (not installed)
  1.20.13 (not installed)
# ...
  1.3rc1  (not installed)
  1.2.2   (not installed)
  1       (not installed)

The -only=<prefix> flag can be used to print only versions starting with the prefix.

> goversion ls -all -only=1.18
  1.18.10   (not installed)
  1.18.9    (not installed)
  1.18.8    (not installed)
# ...
  1.18rc1   (not installed)
  1.18beta2 (not installed)
  1.18beta1 (not installed)

If the -only=latest combination is given, ls prints only the latest patch for each version.

> goversion ls -all -only=latest
  tip     (not installed)
  1.20.14 (not installed)
  1.19.13 (not installed)
# ...
  1.3.3   (not installed)
  1.2.2   (not installed)
  1       (not installed)

Remove

Removes the specified Go version (both binary and SDK).

> goversion rm 1.18
Removed 1.18

Help

Usage: goversion [flags] <command> [command flags]

Commands:
    use main              switch to the main Go version
    use <version>         switch to the specified Go version (will be installed if not exists)
    ls                    print the list of installed Go versions
        -a (-all)         print also available versions from go.dev
        -only=<prefix>    print only versions starting with the prefix
        -only=latest      print only the latest patch for each version
    rm <version>          remove the specified Go version (both binary and SDK)

Flags:
    -h (-help)            print this message and quit
    -v (-version)         print the version of goversion itself and quit