https://github.com/dustinblackman/gomodrun

The forgotten go tool that executes and caches binaries included in go.mod files.
https://github.com/dustinblackman/gomodrun

Last synced: 3 months ago
JSON representation

The forgotten go tool that executes and caches binaries included in go.mod files.

• Host: GitHub
• URL: https://github.com/dustinblackman/gomodrun
• Owner: dustinblackman
• License: mit
• Created: 2020-01-26T15:33:18.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2024-05-17T01:56:28.000Z (6 months ago)
• Last Synced: 2024-05-29T00:02:49.398Z (5 months ago)
• Language: Go
• Size: 540 KB
• Stars: 32
• Watchers: 3
• Forks: 4
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-go-extra - gomodrun - 01-26T15:33:18Z|2022-08-25T10:41:05Z| (Go Tools / Routers)

README

        
![gomodrun](assets/banner.jpg)

[![Build Status](https://img.shields.io/github/workflow/status/dustinblackman/gomodrun/Test?branch=master)](https://github.com/dustinblackman/gomodrun/actions)

[![Release](https://img.shields.io/github/v/release/dustinblackman/gomodrun)](https://github.com/dustinblackman/gomodrun/releases)

[![Coverage Status](https://coveralls.io/repos/github/dustinblackman/gomodrun/badge.svg?branch=master)](https://coveralls.io/github/dustinblackman/gomodrun?branch=master)

[![Go Report Card](http://goreportcard.com/badge/dustinblackman/gomodrun)](http://goreportcard.com/report/dustinblackman/gomodrun)

[![Godocs](https://godoc.org/github.com/dustinblackman/gomodrun?status.svg)](https://pkg.go.dev/github.com/dustinblackman/gomodrun?tab=doc)

The forgotten go tool that executes and caches binaries included in go.mod files. This makes it easy to version cli tools in your projects such as `golangci-lint` and `ginkgo` that are versioned locked to what you specify in `go.mod`. Binaries are cached by go version and package version.

## Example

```sh

  # Run a linter

  gomodrun golangci-lint run

  # Convert a JSON object to a Go struct, properly passing in stdin.

  echo example.json | gomodrun gojson > example.go

  # Specifiy alternative root directory containing a go.mod and tools file.

  gomodrun -r ./alternative-tools-dir golangci-lint run

  # Clean your .gomodrun folder of unused binaries.

  gomodrun --tidy

```

## Install

### Source

```sh

curl -L "https://github.com/dustinblackman/gomodrun/archive/refs/heads/master.tar.gz" | tar zxvf - -C /tmp

cd /tmp/gomodrun-master/cmd/gomodrun

go install .

```

## Usage

gomodrun works by using a `tools.go` (or any other name) file that sits in the root of your project that contains all the CLI dependencies you want bundled in to your `go.mod`. Note the `// +build tools` at the top of the file is required, and allows you to name your tools file anything you like.

__tools.go__

```go

// +build tools

package myapp

import (

	_ "github.com/golangci/golangci-lint/cmd/golangci-lint"

	_ "github.com/onsi/ginkgo/ginkgo"

)

```

Run `go build tools.go` to add the dependencies to your `go.mod`. The build is expected to fail.

### CLI

You can run your tools by prefixing `gomodrun`. A binary will be built and cached in `.gomodrun` in the root of your project, allowing all runs after the first to be nice and fast.

```sh

  gomodrun golangci-lint run

```

### Programmatically

You can also use `gomodrun` as a library.

```go

package main

import (

	"os"

	"github.com/dustinblackman/gomodrun"

)

func main() {

	exitCode, err := gomodrun.Run("golangci-lint", []string{"run"}, &gomodrun.Options{

		Stdin:   os.Stdin,

		Stdout:  os.Stdout,

		Stderr:  os.Stderr,

		Env:     os.Environ(),

		PkgRoot: "",

	})

}

```

## [License](./LICENSE)

MIT