Skip to content

README_CN.md

Latest commit

 

History

History
250 lines (183 loc) · 8.63 KB

README_CN.md

File metadata and controls

250 lines (183 loc) · 8.63 KB

g

GitHub release (latest by date) GoDoc codecov codebeat badge Go Report Card

English 🇺🇸

注意：master分支可能处于开发之中并非稳定版本，请通过 tag 下载稳定版本的源代码，或通过release下载已编译的二进制可执行文件。

g是一个 Linux、macOS、Windows 下的命令行工具，可以提供一个便捷的多版本 go 环境的管理和切换。

asciicast

特性

  • 支持列出可供安装的 go 版本号
  • 支持列出已安装的 go 版本号
  • 支持在本地安装多个 go 版本
  • 支持卸载已安装的 go 版本
  • 支持在已安装的 go 版本之间自由切换
  • 支持清空安装包文件缓存
  • 支持软件自我更新（>= 1.5.0）
  • 支持软件绿色卸载（>= 1.5.0）

安装

自动化安装

  • Linux/macOS（适用于 bash、zsh）

    # 建议安装前清空`GOROOT`、`GOBIN`等环境变量
$ curl -sSL https://raw.githubusercontent.com/voidint/g/master/install.sh | bash
$ cat << 'EOF' >> ~/.bashrc
# 可选。检查g别名是否被占用
if [[ -n $(alias g 2>/dev/null) ]]; then
    unalias g
fi
EOF
$ source "$HOME/.g/env"

  • Windows（适用于 pwsh）

    $ iwr https://raw.githubusercontent.com/voidint/g/master/install.ps1 -useb | iex

手动安装（Linux/macOS）

  • 创建 g 家目录（推荐~/.g目录）

  • 下载release的二进制压缩包，并解压至 g 家目录下的 bin 子目录中（即~/.g/bin目录）。

  • 将所需的环境变量写入~/.g/env文件

    $ cat >~/.g/env <<'EOF'
#!/bin/sh
# g shell setup
export GOROOT="${HOME}/.g/go"
[ -z "$GOPATH" ] && export GOPATH="${HOME}/go"
export PATH="${HOME}/.g/bin:${GOROOT}/bin:${GOPATH}/bin:$PATH"
export G_MIRROR=https://golang.google.cn/dl/
EOF

  • 将~/.g/env导入到 shell 环境配置文件（如~/.bashrc、~/.zshrc...）

    $ cat >>~/.bashrc <<'EOF'
if [[ -n $(alias g 2>/dev/null) ]]; then
    unalias g
fi
[ -s "${HOME}/.g/env" ] && \. "${HOME}/.g/env"  # g shell setup
EOF

  • 启用环境变量

    $ source ~/.bashrc # 或source ~/.zshrc

手动安装（Windows + powershell）

  • 创建目录mkdir ~/.g/bin

  • 下载release的 windows 版本的二进制压缩包, 解压之后放到~/.g/bin目录下

  • 默认二进制文件名是 g.exe, 如果你已经用 g 这个命令已经用作为 git 的缩写，那么你可以把 g.exe 改为其他名字，如 gvm.exe

  • 执行命令code $PROFILE, 这个命令会用 vscode 打开默认的 powershell 配置文件

  • 在 powershell 的默认配置文件中加入如下内容

    $env:GOROOT="$HOME\.g\go"
$env:Path=-join("$HOME\.g\bin;", "$env:GOROOT\bin;", "$env:Path")

  • 再次打开 powershell 终端，就可以使用 g 或者 gvm 命令了

使用

查询当前可供安装的stable状态的 go 版本

$ g ls-remote stable
  1.19.10
  1.20.5

安装目标 go 版本1.20.5

$ g install 1.14.7
Downloading 100% [===============] (92/92 MB, 12 MB/s)
Computing checksum with SHA256
Checksums matched
Now using go1.20.5

查询已安装的 go 版本

$ g ls
  1.19.10
* 1.20.5

查询可供安装的所有 go 版本

$ g ls-remote
  1
  1.2.2
  1.3
  1.3.1
  ...    // 省略若干版本
  1.19.10
  1.20rc1
  1.20rc2
  1.20rc3
  1.20
  1.20.1
  1.20.2
  1.20.3
  1.20.4
* 1.20.5

切换到另一个已安装的 go 版本

$ g use 1.19.10
go version go1.19.10 darwin/arm64

卸载一个已安装的 go 版本

$ g uninstall 1.19.10
Uninstalled go1.19.10

清空 go 安装包文件缓存

$ g clean
Remove go1.18.10.darwin-arm64.tar.gz
Remove go1.19.10.darwin-arm64.tar.gz
Remove go1.20.5.darwin-arm64.tar.gz

查看 g 版本信息

g version 1.5.0
build: 2023-01-01T21:01:52+08:00
branch: master
commit: cec84a3f4f927adb05018731a6f60063fd2fa216

更新 g 软件本身

$ g self update
You are up to date! g v1.5.0 is the latest version.

卸载 g 软件本身

$ g self uninstall
Are you sure you want to uninstall g? (Y/n)
y
Remove /Users/voidint/.g/bin/g
Remove /Users/voidint/.g

FAQ

  • 环境变量G_MIRROR有什么作用？

    由于中国大陆无法自由访问 Golang 官网，导致查询及下载 go 版本都变得困难，因此可以通过该环境变量指定一个或多个镜像站点（多个镜像站点之间使用英文逗号分隔），g 将从该站点查询、下载可用的 go 版本。已知的可用镜像站点如下：

  • 哪些站点的 URL 可以作为G_MIRROR的值？ g通过网页解析的方式获取其中包含的 Go 版本信息，针对特定类型的网页结构实现了若干的版本采集器。目前支持的采集器包括以下几种：

    • Official Collector ：Go官网采集器。只要网页 HTML 结构和 golang 官方下载页面(如https://go.dev/dl/)一致，都可以使用该采集器。设置示例，如G_MIRROR=official|https://golang.google.cn/dl/，其中，|之前的部分为采集器名称，之后的部分为目标页面的 URL。
    • FancyIndex Collector：适用于 Nginx FancyIndex 模块渲染的网页。设置示例，如G_MIRROR=fancyindex|https://mirrors.aliyun.com/golang/。
    • AutoIndex Collector：适用于 Nginx AutoIndex 模块渲染的网页。设置示例，如G_MIRROR=autoindex|https://mirrors.ustc.edu.cn/golang/。

  • 环境变量G_EXPERIMENTAL有什么作用？

    当该环境变量的值为true时，将开启所有的实验特性。

  • 环境变量G_HOME有什么作用？

    按照惯例，g 默认会将~/.g目录作为其家目录。若想自定义家目录（Windows 用户需求强烈），可使用该环境变量切换到其他家目录。由于该特性还属于实验特性，需要先开启实验特性开关G_EXPERIMENTAL=true才能生效。特别注意，该方案并不十分完美，因此才将其归类为实验特性，详见#18。

  • macOS 系统下安装 go 版本，g 抛出[g] Installation package not found字样的错误提示，是什么原因？

    Go 官方在1.16版本中才加入了对 ARM 架构的 macOS 系统的支持。因此，ARM 架构的 macOS 系统下均无法安装 1.15 及以下的版本的 go 安装包。若尝试安装这些版本，g 会抛出[g] Installation package not found的错误信息。

  • 是否支持网络代理？

    支持。可在HTTP_PROXY、HTTPS_PROXY、http_proxy、https_proxy等环境变量中设置网络代理地址。

  • 支持哪些 Windows 版本？

    因为g的实现上依赖于符号链接，因此操作系统必须是Windows Vista及以上版本。

  • Windows 版本安装以后不生效？

    这有可能是因为没有把下载安装的加入到 $Path 的缘故，需要手动将 $Path 纳入到用户的环境变量中。为了方便起见，可以使用项目中的 path.ps1 的 PowerShell 脚本运行然后重新启动计算机即可。

  • 使用 g 安装了某个 go 版本后，执行go version命令，但输出的 go 版本号并非是所安装的那个版本，这是不是 bug ？

    由于当前 shell 环境中PATH环境变量设置有误导致（建议执行which go查看二进制文件所在路径）。在未修改 g 家目录的情况下，二进制文件 go 的路径应该是~/.g/go/bin/go，如果不是这个路径，就说明PATH环境变量设置有误。

  • 支持源代码编译安装吗？

    不支持

鸣谢

感谢nvm、n、rvm等工具提供的宝贵思路。