How to print the licenses used in my project using Go Modules?

Viewed 3381
1 Answers

Have you tried github.com/google/go-licenses?

Run

go get -v github.com/google/go-licenses
go build github.com/google/go-licenses
./go-licenses csv .

That gives you some information at least.

A bit more verbosity: So I create a test project:

package main

import (
    "encoding/json"
    "fmt"
    log "github.com/sirupsen/logrus"
)

func main() {
    log.Warn("Warn")
    foo := make(map[string]bool)
    foo["bar"] = true
    j, _ := json.MarshalIndent(foo, " ", " ")
    fmt.Println(string(j))
}

The I do:

me@dattan:~/testing/blabla$ go mod init example.com/test
go: creating new go.mod: module example.com/test
me@dattan:~/testing/blabla$ go build
go: finding module for package github.com/sirupsen/logrus
go: downloading github.com/sirupsen/logrus v1.5.0
go: found github.com/sirupsen/logrus in github.com/sirupsen/logrus v1.5.0
go: downloading golang.org/x/sys v0.0.0-20190422165155-953cdadca894
me@dattan:~/testing/blabla$ go get -v github.com/google/go-licenses
go: downloading github.com/google/go-licenses v0.0.0-20200227160636-0fa8c766a591
... [lots of downloads, that's why -v to see it's not dead]
github.com/google/go-licenses
me@dattan:~/testing/blabla$ go build github.com/google/go-licenses
me@dattan:~/testing/blabla$ ./go-licenses csv .
E0406 23:03:48.578291   32389 library.go:108] Failed to find license for example.com/test: no file/directory matching regexp "^(LICEN(S|C)E|COPYING|README|NOTICE)(\\..+)?$" found for /home/me/testing/blabla
E0406 23:03:48.627889   32389 csv.go:84] Error discovering URL for "/home/me/go/pkg/mod/golang.org/x/sys@v0.0.0-20191119060738-e882bf8e40c2/LICENSE":
- unsupported package host "golang.org" for "golang.org/x/sys/unix"
example.com/test,Unknown,Unknown
github.com/sirupsen/logrus,https://github.com/sirupsen/logrus/blob/master/LICENSE,MIT
golang.org/x/sys/unix,Unknown,BSD-3-Clause

And those last lines there, not perfect but it does see that logrus is MIT and provide the link to the license. My test package lacking a LICENSE file fails of course.

Edit from comment While the above worked for me these are the commands the asker needed to do:

go build ./... 
./go-licenses csv ./...
Related