How CodeGeeX writes Go private repository_CodeGeeX configures GOPrivate access [Go private]

It is necessary to configure GOPRIVATE, GOProxy=...,direct, Git credentials/SSH keys, initialize go.mod and verify the gopls environment to ensure that CodeGeeX recognizes private modules.

If you use CodeGeeX to write Go code and need to pull or push it to a private repository (such as the company's intranet GitLab, self-built Gitea, etc.), but the Go module fails to download or prompts "unknown revision" or "no matching versions", it is likely that the GOPRIVATE environment variable is not configured or the go command does not recognize the private domain name. The following are the specific steps to configure Go private warehouse access in the CodeGeeX environment:

1. Set the GOPRIVATE environment variable

GOPRIVATE is used to tell the Go command which module paths should be treated as private, skipping public proxies (such as proxy.golang.org) and verification (such as sum.golang.org), and pulling directly from the source address. This variable needs to take effect in the Shell or IDE terminal environment that CodeGeeX relies on to run.

1. Open the system terminal (macOS/Linux) or PowerShell (Windows).

2. Execute the command to set GOPRIVATE to your private domain name. For example, if the private warehouse domain name is git.example.com, run: export GOPRIVATE=git.example.com (Linux/macOS) or $env:GOPRIVATE="git.example.com" (PowerShell).

3. If there are multiple private domain names, separate them with commas, for example: export GOPRIVATE=git.example.com,dev.internal,mygitea.local .

4. Write the environment variable into the Shell configuration file (such as ~/.zshrc, ~/.bashrc or $PROFILE) to ensure that it takes effect every time you start the terminal.

2. Configure Go proxy to exclude private domain names

Even if GOPRIVATE is set, if GOProxy does not exclude private paths, Go may still try to resolve private modules through the proxy, resulting in a 404 or authentication failure. GoProxy needs to be configured explicitly to skip private domain name matching.

1. Execute the command to set up GoProxy, keep the default proxy but add comma-separated "direct" instructions, for example: export GOProxy=https://proxy.golang.org,direct .

2. Make sure "direct" is at the end of the list, which means that when the module path matches GOPRIVATE, Go will bypass all proxies and connect directly to the source server.

3. Verify that the configuration is effective: run go env GOPRIVATE GOProxy and confirm that the output contains the target domain name in GOPRIVATE and "direct" in GOProxy.

3. Configure Git credentials or SSH keys for private repositories

CodeGeeX itself does not manage Git authentication, but the go command it calls relies on the local Git tool chain when fetching private modules. If the private warehouse requires authentication (HTTP Basic or SSH), Git credentials must be configured in advance, otherwise the pull will fail.

1. If you use HTTPS to access the private Git server, run: git config --global credential.helper store . Then enter the username and password when git clone the private warehouse for the first time, and Git will automatically save it.

2. If you use SSH, make sure ~/.ssh/id_rsa.pub has been added to the Deploy Keys or SSH Keys of the private Git service (such as GitLab), and test the connection: ssh -T [email protected] .

3. Force Go to use SSH instead of HTTPS: declare the module path in go.mod in SSH format, such as module [email protected]:myorg/mypkg , and ensure that URL rewriting is enabled in the Git global configuration: git config --global url."[email protected]:".insteadOf "https://git.example.com/" .

4. Verify private module import in CodeGeeX project

CodeGeeX's code completion and diagnosis depend on the Go module environment of the current workspace. Merely configuring global environment variables is not enough to trigger real-time analysis. You need to ensure that there is a correctly initialized go.mod in the project root directory and that private dependencies can be successfully loaded.

1. Execute in the project root directory: go mod init example.com/myapp (if it has not been initialized yet).

2. Manually add private module dependencies: go get git.example.com/team/[email protected] .

3. Check whether go.mod has added the corresponding require line, and there are no verification errors in go.sum.

4. Restart the CodeGeeX plug-in or reload the VS Code window to make the Go language server (gopls) re-index the module dependencies.

5. Troubleshoot common reasons why CodeGeeX cannot recognize private modules

CodeGeeX provides intelligent prompts based on gopls, and the behavior of gopls is strictly constrained by the underlying Go environment. If "cannot find module providing package" is still prompted after configuration, you need to verify the runtime context item by item.

1. Confirm that the Go version used by CodeGeeX is consistent with the go version output in the terminal to avoid env reading confusion caused by the coexistence of multiple versions of Go.

2. Check whether "Inherit parent process environment" is enabled in the IDE where CodeGeeX is located (such as VS Code). If it is disabled, variables such as GOPRIVATE will not be passed to the gopls child process.

3. Open the command panel (Ctrl Shift P) in the CodeGeeX editor, execute "Go: Locate Configured Go Tools", check the GOROOT, GOPATH and environment variable snapshots, and confirm that the GOPRIVATE value exists and is correct.

4. Temporarily create a .go-version file in the project root directory and write the specified Go version number (such as 1.21.5) to force CodeGeeX to use this version to start gopls to avoid version compatibility interference.

The above is the detailed content of How CodeGeeX writes Go private repository_CodeGeeX configures GOPrivate access [Go private]. For more information, please follow other related articles on the PHP Chinese website!