---
title: "Go Module"
description: "pull GitHub repos referenced by Go module to scan files for symbol content"
source: "https://github.com/log-10x/modules/tree/main/pipelines/compile/modules/pull/gomod/module.yaml"
icon: "material/language-go"
hidden: "true"
---
Scan Go [module](https://go.dev/doc/modules/gomod-ref){target="\_blank"} files (.mod) for GitHub repository dependencies.
Scanning module files enables the compile pipeline to [pull](https://doc.log10x.com/compile/pull/github/ "Pull folders from GitHub repositories to scan for symbol content") these repositories and [scan](https://doc.log10x.com/compile/scan/ "Capture symbol values from source code/binary files and link to an output symbol library") their source files for symbols to build metadata dictionaries.
## :material-wrench-outline: Config Files
To configure the Go module module, [:material-cog: Edit](https://doc.log10x.com/config/app/#module-config "Learn how to edit app and module configurations") these files.
Below is the default configuration from: [gomod/config.yaml](https://github.dev/log-10x/config/blob/main/pipelines/compile/pull/gomod/config.yaml "gomod/config.yaml"){target="\_blank"} (** Required Fields*).
ewogICJ0eXBlIiA6ICJvYmplY3QiLAogICJwcm9wZXJ0aWVzIiA6IHsKICAgICJ0ZW54IiA6IHsKICAgICAgInR5cGUiIDogInN0cmluZyIKICAgIH0sCiAgICAiZ29tb2QiIDogewogICAgICAidHlwZSIgOiAib2JqZWN0IiwKICAgICAgImFkZGl0aW9uYWxQcm9wZXJ0aWVzIiA6IGZhbHNlLAogICAgICAicHJvcGVydGllcyIgOiB7CiAgICAgICAgInB1bGxHaXRIdWJUb2tlbiIgOiB7CiAgICAgICAgICAidHlwZSIgOiBbCiAgICAgICAgICAgICJzdHJpbmciLAogICAgICAgICAgICAibnVsbCIKICAgICAgICAgIF0sCiAgICAgICAgICAibWFya2Rvd25EZXNjcmlwdGlvbiIgOiAiR2l0SHViIEFQSSB0b2tlbiBmb3IgcHVsbGluZyByZXBvc2l0b3JpZXNcblxuRGVmaW5lcyBhbiBhY2Nlc3MgdG9rZW4gZm9yIHB1bGxpbmcgW0dpdGh1YiByZXBvc10oaHR0cHM6Ly9kb2MubG9nMTB4LmNvbS9jb21waWxlL3B1bGwvZ2l0aHViLykgcmVmZXJlbmNlZCBieSBHbyAubW9kIGZpbGVzLiBJZiBub3Qgc2V0LCBkbyBub3QgcHVsbCBHaXRIdWIgcmVwb3MgZm9yIEdvIGRlcGVuZGVuY2llcy4iCiAgICAgICAgfSwKICAgICAgICAicHJveHlVUkwiIDogewogICAgICAgICAgInR5cGUiIDogWwogICAgICAgICAgICAic3RyaW5nIiwKICAgICAgICAgICAgIm51bGwiCiAgICAgICAgICBdLAogICAgICAgICAgIm1hcmtkb3duRGVzY3JpcHRpb24iIDogIkdvIG1vZHVsZSBwcm94eSBVUkxcblxuU3BlY2lmaWVzIGEgR28gbW9kdWxlIHByb3h5IGZvciBkb3dubG9hZGluZyBpbmRpcmVjdCBtb2R1bGUgZGVwZW5kZW5jaWVzLiBJZiBvbWl0dGVkLCBvbmx5IHByb2Nlc3MgZGlyZWN0IGRlcGVuZGVuY2llcyBmcm9tIHRoZSBnby5tb2QgZmlsZS4gSWYgcHJvdmlkZWQsIGZldGNoZXMgaW5kaXJlY3QgZGVwZW5kZW5jaWVzIHVwIHRvIHRoZSBzcGVjaWZpZWQgbWF4LWRlcHRoLiAoRGVmYXVsdDogW2h0dHBzOi8vcHJveHkuZ29sYW5nLm9yZ10oaHR0cHM6Ly9wcm94eS5nb2xhbmcub3JnKSkiLAogICAgICAgICAgImRlZmF1bHQiIDogIltodHRwczovL3Byb3h5LmdvbGFuZy5vcmddKGh0dHBzOi8vcHJveHkuZ29sYW5nLm9yZykiCiAgICAgICAgfSwKICAgICAgICAibWF4UmVwb3MiIDogewogICAgICAgICAgInR5cGUiIDogWwogICAgICAgICAgICAibnVtYmVyIiwKICAgICAgICAgICAgInN0cmluZyIsCiAgICAgICAgICAgICJudWxsIgogICAgICAgICAgXSwKICAgICAgICAgICJtYXJrZG93bkRlc2NyaXB0aW9uIiA6ICJMaW1pdCB0aGUgb3ZlcmFsbCBudW1iZXIgb2YgR2l0SHViIHJlcG9zIHRvIHB1bGxcblxuU3BlY2lmaWVzIGEgZ2xvYmFsIGxpbWl0IGZvciB0aGUgbnVtYmVyIG9mIHJlcG9zaXRvcmllcyBjb2xsZWN0ZWQgKEFjY2VwdHMgbnVtYmVyIG9yIHN0cmluZyB3aXRoICQ9IHByZWZpeCBmb3IgcnVudGltZSBldmFsdWF0aW9uKSAoRGVmYXVsdDogMjAwKSIsCiAgICAgICAgICAiZGVmYXVsdCIgOiAyMDAKICAgICAgICB9LAogICAgICAgICJtYXhEZXB0aCIgOiB7CiAgICAgICAgICAidHlwZSIgOiBbCiAgICAgICAgICAgICJudW1iZXIiLAogICAgICAgICAgICAic3RyaW5nIiwKICAgICAgICAgICAgIm51bGwiCiAgICAgICAgICBdLAogICAgICAgICAgIm1hcmtkb3duRGVzY3JpcHRpb24iIDogIkxpbWl0IHRoZSBkZXB0aCBvZiBtb2R1bGUgZGVwZW5kZW5jeSByZWN1cnNpb25cblxuRGVwdGggc3RhcnRzIGF0IDAgZm9yIHRoZSBpbml0aWFsIC5tb2QgZmlsZSAoZGlyZWN0IGRlcHMpLCBpbmNyZW1lbnRzIHRvIDEgZm9yIGZpcnN0LWxldmVsIGluZGlyZWN0IGRlcHMsIGFuZCAyIGZvciBzZWNvbmQtbGV2ZWwsIHN0b3BwaW5nIGJlZm9yZSBhIHRoaXJkIGxldmVsIChkZXB0aCAzKS4gIERlcHRoIExpbWl0ICgyKTogIC0gTGV2ZWwgMDogRGlyZWN0IGRlcGVuZGVuY2llcyBpbiB5b3VyIC5tb2QgZmlsZS4gLSBMZXZlbCAxOiBEZXBlbmRlbmNpZXMgb2YgdGhvc2UgZGlyZWN0IG1vZHVsZXMuIC0gTGV2ZWwgMjogRGVwZW5kZW5jaWVzIG9mIGxldmVsIDEgbW9kdWxlcy4gIFN0b3BzIGF0IGxldmVsIDMsIGNvdmVyaW5nIHR3byBsZXZlbHMgb2YgaW5kaXJlY3QgZGVwZW5kZW5jaWVzLiBGb3IgbW9zdCBHbyBwcm9qZWN0cywgdGhpcyBjYXB0dXJlcyB0aGUgYnVsayBvZiByZWxldmFudCBHaXRIdWIgcmVwb3Mgd2l0aG91dCBleHBsb2RpbmcgcnVudGltZS4gIEV4YW1wbGU6IElmIHlvdXJBcHAg4oaSIGdvbGFuZy5vcmcveC90b29scyDihpIgZ2l0aHViLmNvbS9nb2xhbmcvZ28sIGRlcHRoIDIgZ2V0cyBib3RoLCBidXQgc3RvcHMgYmVmb3JlIGZldGNoaW5nIGdv4oCZcyBkZXBzLiAoQWNjZXB0cyBudW1iZXIgb3Igc3RyaW5nIHdpdGggJD0gcHJlZml4IGZvciBydW50aW1lIGV2YWx1YXRpb24pIChEZWZhdWx0OiAwKSIsCiAgICAgICAgICAiZGVmYXVsdCIgOiAwCiAgICAgICAgfQogICAgICB9CiAgICB9CiAgfSwKICAiYWRkaXRpb25hbFByb3BlcnRpZXMiIDogZmFsc2UKfQ==
```yaml
# 🔟❎ 'compile' Go module scanner configuration
# Configures the Go .mod scanner which pulls referenced GitHub repositories to scan for symbol values.
# To learn more see https://doc.log10x.com/compile/pull/gomod
# Set the 10x pipeline to 'compile'
tenx: compile
# =============================== Gomod Options ===============================
gomod:
# 'token' specifies the access token for this repo using a shell variable (recommended) or inline
# To learn more see: https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens
pullGitHubToken: $=TenXEnv.get("GH_TOKEN") # (❗ EnvVar REQUIRED)
# 'proxyURL' specifies a Go module proxy for downloading indirect module dependencies.
# If omitted, only process direct dependencies from the go.mod file.
# If provided, fetches indirect dependencies up to the specified max-depth.
proxyURL: https://proxy.golang.org/
# 'maxDepth' limits the depth of module dependency recursion
# Depth starts at 0 for the initial .mod file (direct deps), increments to 1 for first-level indirect deps,
# and 2 for second-level, stopping before a third level (depth 3).
maxDepth: 0
```
## :material-menu: Options
Specify the options below to [configure](/config "configure") the Go module:
|Name|Description|
|---|---|
|[gomodPullGitHubToken](#gomodpullgithubtoken "GitHub API token for pulling repositories")|GitHub API token for pulling repositories|
|[gomodProxyURL](#gomodproxyurl "Go module proxy URL")|Go module proxy URL|
|[gomodMaxRepos](#gomodmaxrepos "limit the overall number of GitHub repos to pull")|Limit the overall number of GitHub repos to pull|
|[gomodMaxDepth](#gomodmaxdepth "limit the depth of module dependency recursion")|Limit the depth of module dependency recursion|
### :material-menu-right-outline:**`gomodPullGitHubToken`**
GitHub API token for pulling repositories.
|Type|Default|
|---|---|
|String|""|
Defines an access token for pulling [Github repos](https://doc.log10x.com/compile/pull/github/ "Pull folders from GitHub repositories to scan for symbol content") referenced by Go .mod files.
If not set, do not pull GitHub repos for Go dependencies.
### :material-menu-right-outline:**`gomodProxyURL`**
Go module proxy URL.
|Type|Default|
|---|---|
|String|[https://proxy.golang.org](https://proxy.golang.org "Pull GitHub repos referenced by Go module to scan files for symbol content"){target="\_blank"}|
Specifies a Go module proxy for downloading indirect module dependencies.
If omitted, only process direct dependencies from the go.mod file.
If provided, fetches indirect dependencies up to the specified max-depth.
### :material-menu-right-outline:**`gomodMaxRepos`**
Limit the overall number of GitHub repos to pull.
|Type|Default|
|---|---|
|Number|200|
Specifies a global limit for the number of repositories collected.
### :material-menu-right-outline:**`gomodMaxDepth`**
Limit the depth of module dependency recursion.
|Type|Default|
|---|---|
|Number|0|
Depth starts at 0 for the initial .mod file (direct deps), increments to 1 for first-level indirect deps,
and 2 for second-level, stopping before a third level (depth 3).
Depth Limit (2):
- Level 0: Direct dependencies in your .mod file.
- Level 1: Dependencies of those direct modules.
- Level 2: Dependencies of level 1 modules.
Stops at level 3, covering two levels of indirect dependencies. For most Go projects, this captures the bulk of relevant GitHub repos without exploding runtime.
Example: If yourApp → golang.org/x/tools → github.com/golang/go, depth 2 gets both, but stops before fetching go’s deps.
:material-github: This module is defined in [gomod/module.yaml](https://github.com/log-10x/modules/tree/main/pipelines/compile/modules/pull/gomod/module.yaml "gomod/module.yaml"){target="\_blank"}.