go-tool-cache

Like Go's built-in build/test caching but wish it weren't purely stored on local disk in the $GOCACHE directory?

Want to share your cache over the network between your various machines, coworkers, and CI runs without all that GitHub actions/caches tarring and untarring?

Along with a modification to Go's cmd/go tool (open proposal), this repo lets you write custom GOCACHE implementations to handle the cache however you'd like.

Status

• Starting from Go 1.24 you can use the official golang releases. For protocol details - see the documentation
• This was previously behind a GOEXPERIMENT

Using

First, build your cache child process. For example,

$ go install github.com/bradfitz/go-tool-cache/cmd/go-cacher

Then tell Go to use it:

$ GOCACHEPROG=$HOME/go/bin/go-cacher go install std

See some stats:

$ GOCACHEPROG="$HOME/go/bin/go-cacher --verbose" go install std
Defaulting to cache dir /home/bradfitz/.cache/go-cacher ...
cacher: closing; 548 gets (0 hits, 548 misses, 0 errors); 1090 puts (0 errors)

Run it again and watch the hit rate go up:

$ GOCACHEPROG="$HOME/go/bin/go-cacher --verbose" go install std
Defaulting to cache dir /home/bradfitz/.cache/go-cacher ...
cacher: closing; 808 gets (808 hits, 0 misses, 0 errors); 0 puts (0 errors)

S3 Support

We support S3 backend for caching. You can connect to S3 backend by setting the following parameters:

• GOCACHE_S3_BUCKET - Name of S3 bucket
• GOCACHE_AWS_REGION - AWS Region of bucket
• GOCACHE_AWS_ACCESS_KEY + GOCACHE_AWS_SECRET_KEY / GOCACHE_AWS_CREDS_PROFILE - Direct credentials or creds profile to use.
• GOCACHE_CACHE_KEY - (Optional, default v1) Unique key

The cache would be stored to s3://<bucket>/cache/<cache_key>/<architecture>/<os>/<go-version>