gvm README

The project's README from github.com/moovweb/gvm. As one markdown file: README.md.

gvm

Build Status

By Josh Bussdieker (jbuss, jaja, jbussdieker) while working at Moovweb

Currently lovingly maintained by Benjamin Knigge

Pull requests and other any other contributions would be very much appreciated.

GVM provides an interface to manage Go versions.

Features

Background

When we started developing in Go mismatched dependencies and API changes plagued our build process and made it extremely difficult to merge with other peoples changes.

After nuking my entire GOROOT several times and rebuilding I decided to come up with a tool to oversee the process. It eventually evolved into what gvm is today.

Installing

To install:

  1. Install Bison:

    sudo apt-get install bison

  2. Install gvm:

    bash < <(curl -s -S -L https://raw.githubusercontent.com/moovweb/gvm/master/binscripts/gvm-installer)

Or if you are using zsh just change bash with zsh

Installing Go

gvm install go1.4
gvm use go1.4 [--default]

Once this is done Go will be in the path and ready to use. $GOROOT and $GOPATH are set automatically.

Additional options can be specified when installing Go:

Usage: gvm install [version] [options]
    -s,  --source=SOURCE      Install Go from specified source.
    -n,  --name=NAME          Override the default name for this version.
    -pb, --with-protobuf      Install Go protocol buffers.
    -b,  --with-build-tools   Install package build tools.
    -B,  --binary             Only install from binary.
         --prefer-binary      Attempt a binary install, falling back to source.
    -h,  --help               Display this message.

A Note on Compiling Go 1.5+

Go 1.5+ removed the C compilers from the toolchain and replaced them with one written in Go. Obviously, this creates a bootstrapping problem if you don't already have a working Go install. In order to compile Go 1.5+, make sure Go 1.4 is installed first. If Go 1.4 won't install try a later version (e.g. go1.5), just make sure you have the -B option after the version number. 

gvm install go1.4 -B
gvm use go1.4
export GOROOT_BOOTSTRAP=$GOROOT
gvm install go1.7

A Note on ARMv6 and ARMv7 architectures (32 bit)

Binary versions for ARMv6 architecture are available starting from Go 1.6. So, it is necessary to bootstrap with an existing binary version, then it will be possible compiling other versions. For instance, to bootstrap a setup, version 1.21.0 may be used:

gvm install go1.21.0 -B
gvm use go1.21.0

And then, compile any other version:

gvm install go1.20.7

To install Go 1.20+

Go 1.20+ requires go1.17.3+. Use the below:

gvm install go1.4 -B
gvm use go1.4
export GOROOT_BOOTSTRAP=$GOROOT
gvm install go1.17.13
gvm use go1.17.13
export GOROOT_BOOTSTRAP=$GOROOT
gvm install go1.20
gvm use go1.20

List Go Versions

To list all installed Go versions (The current version is prefixed with "=>"):

gvm list

To list all Go versions available for download:

gvm listall

Uninstalling

To completely remove gvm and all installed Go versions and packages:

gvm implode

If that doesn't work see the troubleshooting steps at the bottom of this page.

Mac OS X Requirements

xcode-select --install
brew update
brew install mercurial

Linux Requirements

Debian/Ubuntu

sudo apt-get install curl git mercurial make binutils bison gcc build-essential

Redhat/Centos

sudo yum install curl
sudo yum install git
sudo yum install make
sudo yum install bison
sudo yum install gcc
sudo yum install glibc-devel

FreeBSD Requirements

sudo pkg_add -r bash
sudo pkg_add -r git
sudo pkg_add -r mercurial

Vendoring Native Code and Dependencies

GVM supports vendoring package set-specific native code and related dependencies, which is useful if you need to qualify a new configuration or version of one of these dependencies against a last-known-good version in an isolated manner. Such behavior is critical to maintaining good release engineering and production environment hygiene.

As a convenience matter, GVM will furnish the following environment variables to aid in this manner if you want to decouple your work from what the operating system provides:

  1. ${GVM_OVERLAY_PREFIX} functions in a manner akin to a root directory hierarchy suitable for auto{conf,make,tools} where it could be passed in to ./configure --prefix=${GVM_OVERLAY_PREFIX} and not conflict with any existing operating system artifacts and hermetically be used by your workspace. This is suitable to use with C{PP,XX}FLAGS and LDFLAGS, but you will have to manage these yourself, since each tool that uses them is different.

  2. ${PATH} includes ${GVM_OVERLAY_PREFIX}/bin so that any tools you manually install will reside there, available for you.

  3. ${LD_LIBRARY_PATH} includes ${GVM_OVERLAY_PREFIX}/lib so that any runtime library searching can be fulfilled there on FreeBSD and Linux.

  4. ${DYLD_LIBRARY_PATH} includes ${GVM_OVERLAY_PREFIX}/lib so that any runtime library searching can be fulfilled there on Mac OS X.

  5. ${PKG_CONFIG_PATH} includes ${GVM_OVERLAY_PREFIX}/lib/pkgconfig so that pkg-config can automatically resolve any vendored dependencies.

Recipe for success:

gvm use go1.1
gvm pkgset use current-known-good
# Let's assume that this includes some C headers and native libraries, which
# Go's CGO facility wraps for us.  Let's assume that these native
# dependencies are at version V.
gvm pkgset create trial-next-version
# Let's assume that V+1 has come along and you want to safely trial it in
# your workspace.
gvm pkgset use trial-next-version
# Do your work here replicating current-known-good from above, but install
# V+1 into ${GVM_OVERLAY_PREFIX}.

See examples/native for a working example.

Troubleshooting

Sometimes especially during upgrades the state of gvm's files can get mixed up. This is mostly true for upgrade from older version than 0.0.8. Changes are slowing down and a LTR is imminent. But for now rm -rf ~/.gvm will always remove gvm. Stay tuned!

Gitter

gvm (moovweb/gvm)

development-environment
Searching Database…

11.7K ·GitHub
Gvm
What is this?GVM (Go Version Manager) is a shell tool for installing, switching between, and managing multiple Go versions on one machine, together with the GOPATH environments that go with them.
So is it a command-line tool I run in my shell, not a library?Exactly — a bash/zsh script suite that manages the Go toolchain itself and lives under ~/.gvm in your home directory. You never import it into Go code.
How do I install it and get a first Go version running?Run the gvm-installer script from the repo, then 'gvm install go1.4' and 'gvm use go1.4' (add --default to pin it). GOROOT and GOPATH are set automatically and Go is on your path.
What do I need on my machine beforehand?bash or zsh plus build prerequisites: curl, git, Mercurial, make, binutils, Bison and gcc. The README gives package commands for Debian/Ubuntu, RHEL/CentOS and FreeBSD; macOS additionally needs Xcode Command Line Tools and Mercurial.
Is there a catch when installing newer Go versions?Yes: since Go 1.5 the compiler is written in Go, so building Go 1.5+ from source requires a working Go install (1.4 first). The -B flag sidesteps this by installing a prebuilt binary instead.
Which Go versions can I install?Any tagged release: the README cites tags like 60.3, go1, weekly.2011-11-08 or tip, so coverage runs from ancient 2011 releases and weekly snapshots up to the development tip. 'gvm listall' shows exactly what is downloadable.
Can it install Go from binary instead of compiling from source?Yes: -B installs only from binary and --prefer-binary tries binary first with a source fallback. Other install options include --source for a custom source, --with-protobuf, and --with-build-tools.
Why was it created?The author kept nuking his entire GOROOT while fighting mismatched dependencies and API changes in early Go development at Moovweb, so he built a tool to oversee the process — it evolved into gvm.
Is gvm still actively maintained?Development has slowed: the README notes changes are slowing down and a long-term release is imminent. It is maintained by Benjamin Knigge, with pull requests and contributions welcome.
What are similar projects?asdf, pyenv, nvm, dep, oh-my-posh, rye, mise, rbenv
Which topics is it in?development-environment, environment-variables, version-manager, dependency-manager, toolchain, zsh, bash, package-manager, cli-tool, golang, bsd, shell
Creator
moovweb
Size
0.8 MB
Stars
11.7K
Updated
CommitAug 14
Age
14y
Commits · 90 Days