Simple go version manager, gluten-free.
Existing version managers build go from source, have too many dependencies, pollute the PATH, and/or require you to use a specific shell environment. g
aims to be as unobtrusive and portable as possible.
g
is inspired by tj/n - which I have contributed to in the past - and borrows some of its code.
- Run any go version on demand.
- Single portable shell script that ideally lives where your go binaries live.
- Works no matter what shell you use as long as
$GOPATH
and$GOROOT
are exported which... - ...is idiomatic to
go
and not specific tog
. - No need to
source
functions in your shell config. - Downloads pre-built binaries so it is fast and...
- ...requires no git, no mercurial, no gcc, no xcode, etc.
curl
andwget
first-class support alike.- Colorful UI and interactive but safe to pipe and use in automated scripts.
- self-upgrade command to keep up-to-date.
- Option to get go beta versions.
- Get started in golang with a single line using the install script.
- The install script detects name collisions and helps you set an alternative name.
- macOS, Linux or BSD environment. Bash for Windows (WSL) is supported as well.
- Either
curl
orwget
, check withcurl -V
orwget -V
respectively.
Not strictly necessary, but highly recommended, to completely remove any previous go installation — just to prevent any weird outcome.
IMPORTANT: Before you continue, I encourage you to read the install script; never trust someone telling you to run random commands.
That said, you can install g
with a single command:
curl -sSL https://git.io/g-install | sh -s
If you use wget
instead:
wget -qO- https://git.io/g-install | sh -s
That will download the g
script, put it inside $GOPATH/bin/
, give it execution rights with chmod
, and configure your default shell's initialization file, setting the GOPATH
& GOROOT
environment variables and adding $GOPATH/bin
to the PATH
.
Then you will prompted to install the latest version of go; you can skip this step and install your preferred version with g
later.
NOTE: You must restart your current shell session for it to read these new env vars in order to use g
or go
.
The install script currently supports the following shells:
- bash
- zsh
- fish
- ash
- dash
- csh
- tcsh
That doesn't mean you cannot use g
with other shells, just proceed with the manual installation.
The install script is going to select your default shell for configuration. You might see what your default shell is by running:
echo $SHELL
If you wish to configure a diff shell, you might pass it as arguments:
curl -sSL https://git.io/g-install | sh -s -- fish
You might as well configure several shells, but that's usually not required:
curl -sSL https://git.io/g-install | sh -s -- fish bash zsh
Use the -y
option to skip the prompts and assume "yes" for everything:
curl -sSL https://git.io/g-install | sh -s -- -y
By default, these go environment variables are used:
GOROOT: $HOME/.go
GOPATH: $HOME/go
$GOPATH/bin
is added to the PATH
and there's where g
is copied to.
You might set those variables before running the install script. For example, in bash and zsh:
export GOROOT=~/.local/share/golang
export GOPATH=~/MyProjects/go-projects
curl -sSL https://git.io/g-install | sh -s
In fish:
set -gx GOROOT ~/.local/share/golang
set -gx GOPATH ~/MyProjects/go-projects
curl -sSL https://git.io/g-install | sh -s
- Make sure to export the
$GOPATH
&$GOROOT
environment variables and add$GOPATH/bin
to yourPATH
. - Grab a copy of the
./bin/g
script and put it anywhere available in yourPATH
— inside$GOPATH/bin/
is a good option. - Give the script execution rights with
chmod x $GOPATH/bin/g
. - Restart your shell session to make sure the env variables are loaded.
g
includes a self-upgrade
command you can run to get the latest version of g
. This command simply runs the install script once again.
Usage: g [COMMAND] [options] [args]
Commands:
g Open interactive UI with downloaded versions
g install latest Download and set the latest go release
g install <version> Download and set go <version>
g download <version> Download go <version>
g set <version> Switch to go <version>
g run <version> Run a given version of go
g which <version> Output bin path for <version>
g remove <version ...> Remove the given version(s)
g prune Remove all versions except the current version
g list Output downloaded go versions
g list-all Output all available, remote go versions
g self-upgrade Upgrades g to the latest version
g help Display help information, same as g --help
Options:
-h, --help Display help information and exit
-v, --version Output current version of g and exit
-q, --quiet Suppress almost all output
-c, --no-color Force disabled color output
-y, --non-interactive Prevent prompts
-o, --os Override operating system
-a, --arch Override system architecture
-u, --unstable Include unstable versions in list
g
is a single portable shell script that acts like a binary that's available in your $PATH
. If you setup g
with the install script, its removal should be pretty straight forward.
First of all, get some info about your system:
echo $SHELL
echo $GOROOT
echo $GOPATH
command -v g
You will notice the g
file lives inside your $GOPATH/bin/
directory. If you only want to remove g
and keep your currently installed go
binaries and related files, simply delete g
:
# If you're using bash, zsh, or other POSIX shell:
rm "$(command -v g)"
# If you're using fish:
rm (command -v g)
Now, if you want to remove everything, first be sure to backup your projects inside $GOROOT
, if any. Then remove everything inside $GOROOT
and $GOPATH
:
rm -r $GOPATH $GOROOT
Then open your shell config file with your text editor of choice and look of for a line that includes g-install
to remove it. These are the locations usually used by the install script:
# bash on MacOS
~/.bash_profile
# bash on linux/BSD
~/.bashrc
# zsh
~/.zshrc
# fish shell
~/.config/fish/config.fish
# csh
~/.cshrc
# tcsh
~/.tcshrc
# For ash and dash, check your $ENV var
echo $ENV
At this point you would have removed g
and go
entirely.
- Improve docs a bit more
- Make
g
andg-install
POSIX compliant - Add support for more shells
- Warn users they already have a golang installation when using
g-install
- Use better naming for
g install <version>
, maybeuse
orset
. See #8- Use
install
only for install and remove the--download
option
- Use
- Handle the case when
g
already exists, mainlyzsh
withoh-my-zsh
- Make it so
g-install
offers the user to setup an alternative alias forg
- Make it so
- Make the
self-upgrade
command throw ifg
was not installed in the common way - Add a
complete
command that generates completions for the supported shells- And have
g-install
setup the shells to call this command for completions
- And have
- Explore feature to configure shells to autoload go versions based on mod.go
- Test it on diff platforms
- Crete a test setup with
docker andGithub actions - Add more tests
- moovweb/gvm
- Too many features.
- Builds from source, i.e, requires gcc, make, xcode, etc.
- Requires git and mercurial.
- Requires bootstrapping, i.e., install go 1.4 first.
- Specific to a shell, i.e., doesn't work with fishshell.
- syndbg/goenv
- Too many features and weird DX.
- Uses an hard-coded list of go versions...
- ...thus you have to upgrade
goenv
before installing a new version of go. - Adds a lot to your env and PATH.
- hit9/oo
- Pretty much same as
gvm
.
- Pretty much same as
- asdf-golang
- Depends on asdf.
- andrewkroh/gvm
- Bash, batch and powershell support only.
- Cumbersome to use.
- MakeNowJust/govm
- Builds from source.
- Requires python 2.
Please read CONTRIBUTING.md. ♥
- Every contributor to this project.
- The
n
project, whichg
is inspired by and based on. - The
n-install
project, whichg
is also based on.
MIT ♥