goctl env

Overview

goctl env can quickly detect goctl dependency. If your environment is missing a goctl dependency, goctl env will give it a reminder and you can of course install missing dependencies via the goctl env install command.

goctl env directive

  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

The goctl env allows you to quickly view some of the current variables in the goctl environment, and provide this information to the maintainer when users report bugs.

  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 Fieldgoctl env - 图2 Default Valuegoctl env - 图3 Description
GOCTL_OSEmpty stringOperating System
GOCTL_ARCHEmpty stringSystem Architecture
GOCTL_HOMEEmpty stringgoctl configuration directory
GOCTL_DEBUGEmpty stringWhether to enable debug mode, maintainer to use, enumeration values Ture, False
GOCTL_CACHEEmpty stringcache directory
GOCTL_EXPERIMENTALoffWhether to enable the experimental function, enumeration values [on,off]
GOCTL_VERSIONEmpty stringgoctl version
PROTOC_VERSIONEmpty stringprotoc version
PROTOC_GEN_GO_VERSIONEmpty stringprotoc_gen_go plugin version
PROTO_GEN_GO_GRPC_VERSIONEmpty stringprotoc_gen_go_grpc plugin version

goctl env check directive

The goctl env check instructions are ready to quickly detect goctl dependency. If your environment is missing goctl, goctl env check gives a reminder accordingly.

  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 Parameter fieldgoctl env - 图5 Parameter Typegoctl env - 图6 Required?goctl env - 图7 Default valuegoctl env - 图8 Parameter Description
ibooleanNOfalseInstall Dependencies
forcebooleanNOfalseSilent Installing components. If false, each component will eject the installation confirmation option before installing it
verbosebooleanNOfalseExport execution log

Example：

Example 1： detect goctl dependencies

  • 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'

Example 2： detect goctl dependencies and install missing dependencies

  • 不静默安装
  • 静默安装
  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 directive

The goctl env install command has the same function as goctl env checkk —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 Parameter fieldgoctl env - 图10 Parameter Typegoctl env - 图11 Required?goctl env - 图12 Default valuegoctl env - 图13 Parameter Description
forcebooleanNOfalseSilent Installing components. If false, each component will eject the installation confirmation option before installing it
verbosebooleanNOfalseExport execution log