goctl env

概述

goctl env 可以快速检测 goctl 的依赖环境，如果你的环境中缺少了 goctl 的依赖环境，goctl env 会给出相应的提示，当然，你可以可以通过 goctl env install 命令来安装缺失的依赖环境。

goctl env 帮助指令

  1. $ goctl env --help
  2. Check or edit goctl environment
  4. Usage:
  5.   goctl env [flags]
  6.   goctl env [command]
  8. Available Commands:
  9.   check       Detect goctl env and dependency tools
  10.   install     Goctl env installation
  12. Flags:
  13.   -f, --force           Silent installation of non-existent dependencies
  14.   -h, --help            help for env
  15.   -v, --verbose         Enable log output
  16.   -w, --write strings   Edit goctl environment
  19. Use "goctl env [command] --help" for more information about a command.

goctl env 指令

goctl env 可以快速查看当前关于 goctl 环境的一些变量，在用户反馈 bug 时可以将这些信息一并提供给维护人员。

  1. $ goctl env
  2. GOCTL_OS=darwin 
  3. GOCTL_ARCH=arm64
  4. GOCTL_HOME=/Users/sh00414ml/.goctl
  5. GOCTL_DEBUG=False
  6. GOCTL_CACHE=/Users/sh00414ml/.goctl/cache
  7. GOCTL_EXPERIMENTAL=off
  8. GOCTL_VERSION=1.6.5
  9. PROTOC_VERSION=3.19.4
  10. PROTOC_GEN_GO_VERSION=v1.28.0
  11. PROTO_GEN_GO_GRPC_VERSION=1.2.0
goctl env - 图1 字段goctl env - 图2 默认值goctl env - 图3 参数说明
GOCTL_OS空字符串操作系统
GOCTL_ARCH空字符串系统架构
GOCTL_HOME空字符串goctl 配置目录
GOCTL_DEBUG空字符串是否开启 debug 模式，维护者使用，枚举值 Ture、False
GOCTL_CACHE空字符串缓存目录
GOCTL_EXPERIMENTALoff是否开启试验性功能，枚举值 on：开启，off: 关闭
GOCTL_VERSION空字符串goctl 版本
PROTOC_VERSION空字符串protoc 版本
PROTOC_GEN_GO_VERSION空字符串protoc_gen_go 插件版本，没有安装则无
PROTO_GEN_GO_GRPC_VERSION空字符串protoc_gen_go_grpc 插件版本，没有安装则无

goctl env check 指令

goctl env check 指令用于快速检测 goctl 的依赖环境是否准备好，如果你的环境中缺少了 goctl 的依赖环境，goctl env check 会给出相应的提示。

  1. $ goctl env check --help
  2. Detect goctl env and dependency tools
  4. Usage:
  5.   goctl env check [flags]
  7. Flags:
  8.   -h, --help      help for check
  9.   -i, --install   Install dependencies if not found
  12. Global Flags:
  13.   -f, --force     Silent installation of non-existent dependencies
  14.   -v, --verbose   Enable log output
goctl env - 图4 参数字段goctl env - 图5 参数类型goctl env - 图6 是否必填goctl env - 图7 默认值goctl env - 图8 参数说明
ibooleanNOfalse安装依赖组件
forcebooleanNOfalse静默安装组件，如果false，则安装每个组件前会弹出安装确认选项
verbosebooleanNOfalse是否输出执行日志

示例示例：

示例 1： 检测 goctl 依赖环境

  • goctl 环境依赖已经安装
  • goctl 环境依赖未安装
  1. $ goctl env check --verbose
  2. [goctl-env]: preparing to check env
  4. [goctl-env]: looking up "protoc"
  5. [goctl-env]: "protoc" is installed
  7. [goctl-env]: looking up "protoc-gen-go"
  8. [goctl-env]: "protoc-gen-go" is installed
  10. [goctl-env]: looking up "protoc-gen-go-grpc"
  11. [goctl-env]: "protoc-gen-go-grpc" is installed
  13. [goctl-env]: congratulations! your goctl environment is ready!
  1. $ goctl env check --verbose
  2. [goctl-env]: preparing to check env
  4. [goctl-env]: looking up "protoc"
  5. [goctl-env]: "protoc" is not found in PATH
  7. [goctl-env]: looking up "protoc-gen-go"
  8. [goctl-env]: "protoc-gen-go" is not found in PATH
  10. [goctl-env]: looking up "protoc-gen-go-grpc"
  11. [goctl-env]: "protoc-gen-go-grpc" is not found in PATH
  13. [goctl-env]: check env finish, some dependencies is not found in PATH, you can execute
  14. command 'goctl env check --install' to install it, for details, please execute command
  15. 'goctl env check --help'

示例 2： 检测 goctl 依赖环境并安装缺失的依赖环境

  • 不静默安装
  • 静默安装
  1. $ goctl env check --verbose --install
  2. [goctl-env]: preparing to check env
  4. [goctl-env]: looking up "protoc"
  5. [goctl-env]: "protoc" is not found in PATH
  6. [goctl-env]: do you want to install "protoc" [y: YES, n: No]
  7. y
  8. [goctl-env]: preparing to install "protoc"
  9. [goctl-env]: "protoc" is already installed in "/Users/keson/go/bin/protoc"
  11. [goctl-env]: looking up "protoc-gen-go"
  12. [goctl-env]: "protoc-gen-go" is not found in PATH
  13. [goctl-env]: do you want to install "protoc-gen-go" [y: YES, n: No]
  14. y
  15. [goctl-env]: preparing to install "protoc-gen-go"
  16. "protoc-gen-go" installed from cache
  17. [goctl-env]: "protoc-gen-go" is already installed in "/Users/keson/go/bin/protoc-gen-go"
  19. [goctl-env]: looking up "protoc-gen-go-grpc"
  20. [goctl-env]: "protoc-gen-go-grpc" is not found in PATH
  21. [goctl-env]: do you want to install "protoc-gen-go-grpc" [y: YES, n: No]
  22. y
  23. [goctl-env]: preparing to install "protoc-gen-go-grpc"
  24. "protoc-gen-go-grpc" installed from cache
  25. [goctl-env]: "protoc-gen-go-grpc" is already installed in "/Users/keson/go/bin/protoc-gen-go-grpc"
  27. [goctl-env]: congratulations! your goctl environment is ready!
  1. $ goctl env check --verbose --install --force
  2. [goctl-env]: preparing to check env
  4. [goctl-env]: looking up "protoc"
  5. [goctl-env]: "protoc" is not found in PATH
  6. [goctl-env]: preparing to install "protoc"
  7. "protoc" installed from cache
  8. [goctl-env]: "protoc" is already installed in "/Users/keson/go/bin/protoc"
  10. [goctl-env]: looking up "protoc-gen-go"
  11. [goctl-env]: "protoc-gen-go" is not found in PATH
  12. [goctl-env]: preparing to install "protoc-gen-go"
  13. "protoc-gen-go" installed from cache
  14. [goctl-env]: "protoc-gen-go" is already installed in "/Users/keson/go/bin/protoc-gen-go"
  16. [goctl-env]: looking up "protoc-gen-go-grpc"
  17. [goctl-env]: "protoc-gen-go-grpc" is not found in PATH
  18. [goctl-env]: preparing to install "protoc-gen-go-grpc"
  19. "protoc-gen-go-grpc" installed from cache
  20. [goctl-env]: "protoc-gen-go-grpc" is already installed in "/Users/keson/go/bin/protoc-gen-go-grpc"
  22. [goctl-env]: congratulations! your goctl environment is ready!

goctl env install 指令

goctl env install 指令其实和 goctl env check —install 的功能是一样的。

  1. $ goctl env install --help
  2. Goctl env installation
  4. Usage:
  5.   goctl env install [flags]
  7. Flags:
  8.   -h, --help   help for install
  11. Global Flags:
  12.   -f, --force     Silent installation of non-existent dependencies
  13.   -v, --verbose   Enable log output
goctl env - 图9 参数字段goctl env - 图10 参数类型goctl env - 图11 是否必填goctl env - 图12 默认值goctl env - 图13 参数说明
forcebooleanNOfalse静默安装组件，如果false，则安装每个组件前会弹出安装确认选项
verbosebooleanNOfalse是否输出执行日志