许可证工具

这不是 Google 官方支持的产品。

开始之前

要使用此工具，请确保：

已安装 Go v1.16 或更高版本。

切换到您的 Go 项目目录，例如：

git clone git@github.com:google/go-licenses.git
cd go-licenses

下载所需模块：
```
go mod download
```

安装

使用以下命令下载并安装此工具：

go install github.com/google/go-licenses@latest

如果您之前使用 go get 安装此工具，请注意从 Go 1.17 开始，go get 已被弃用用于安装二进制文件。

报告

$ go-licenses report github.com/google/go-licenses
W0410 06:02:57.077781   31529 library.go:86] "golang.org/x/sys/unix" 包含无法检查进一步依赖的非 Go 代码：
/home/username/go/pkg/mod/golang.org/x/sys@v0.0.0-20220111092808-5a964db01320/unix/asm_linux_amd64.s
W0410 06:02:59.476443   31529 library.go:86] "golang.org/x/crypto/curve25519/internal/field" 包含无法检查进一步依赖的非 Go 代码：
/home/username/go/pkg/mod/golang.org/x/crypto@v0.0.0-20220112180741-5e0467b6c7ce/curve25519/internal/field/fe_amd64.s
W0410 06:02:59.486045   31529 library.go:86] "golang.org/x/crypto/internal/poly1305" 包含无法检查进一步依赖的非 Go 代码：
/home/username/go/pkg/mod/golang.org/x/crypto@v0.0.0-20220112180741-5e0467b6c7ce/internal/poly1305/sum_amd64.s
W0410 06:02:59.872215   31529 library.go:253] 模块 github.com/google/go-licenses 的版本为空，默认为 HEAD。许可证 URL 可能不正确。请验证！
W0410 06:02:59.880621   31529 library.go:253] 模块 github.com/google/go-licenses 的版本为空，默认为 HEAD。许可证 URL 可能不正确。请验证！
github.com/emirpasic/gods,https://github.com/emirpasic/gods/blob/v1.12.0/LICENSE,BSD-2-Clause
github.com/golang/glog,https://github.com/golang/glog/blob/23def4e6c14b/LICENSE,Apache-2.0
github.com/golang/groupcache/lru,https://github.com/golang/groupcache/blob/41bb18bfe9da/LICENSE,Apache-2.0
github.com/google/go-licenses,https://github.com/google/go-licenses/blob/HEAD/LICENSE,Apache-2.0
github.com/google/go-licenses/internal/third_party/pkgsite,https://github.com/google/go-licenses/blob/HEAD/internal/third_party/pkgsite/LICENSE,BSD-3-Clause
github.com/google/licenseclassifier,https://github.com/google/licenseclassifier/blob/3043a050f148/LICENSE,Apache-2.0
github.com/google/licenseclassifier/stringclassifier,https://github.com/google/licenseclassifier/blob/3043a050f148/stringclassifier/LICENSE,Apache-2.0
github.com/jbenet/go-context/io,https://github.com/jbenet/go-context/blob/d14ea06fba99/LICENSE,MIT
github.com/kevinburke/ssh_config,https://github.com/kevinburke/ssh_config/blob/01f96b0aa0cd/LICENSE,MIT
github.com/mitchellh/go-homedir,https://github.com/mitchellh/go-homedir/blob/v1.1.0/LICENSE,MIT
github.com/otiai10/copy,https://github.com/otiai10/copy/blob/v1.6.0/LICENSE,MIT
github.com/sergi/go-diff/diffmatchpatch,https://github.com/sergi/go-diff/blob/v1.2.0/LICENSE,MIT
github.com/spf13/cobra,https://github.com/spf13/cobra/blob/v1.4.0/LICENSE.txt,Apache-2.0
github.com/spf13/pflag,https://github.com/spf13/pflag/blob/v1.0.5/LICENSE,BSD-3-Clause
github.com/src-d/gcfg,https://github.com/src-d/gcfg/blob/v1.4.0/LICENSE,BSD-3-Clause
github.com/xanzy/ssh-agent,https://github.com/xanzy/ssh-agent/blob/v0.2.1/LICENSE,Apache-2.0
go.opencensus.io,https://github.com/census-instrumentation/opencensus-go/blob/v0.23.0/LICENSE,Apache-2.0
golang.org/x/crypto,https://cs.opensource.google/go/x/crypto/+/5e0467b6:LICENSE,BSD-3-Clause
golang.org/x/mod/semver,https://cs.opensource.google/go/x/mod/+/9b9b3d81:LICENSE,BSD-3-Clause
golang.org/x/net,https://cs.opensource.google/go/x/net/+/69e39bad:LICENSE,BSD-3-Clause
golang.org/x/sys,https://cs.opensource.google/go/x/sys/+/5a964db0:LICENSE,BSD-3-Clause
golang.org/x/tools,https://cs.opensource.google/go/x/tools/+/v0.1.10:LICENSE,BSD-3-Clause
golang.org/x/xerrors,https://cs.opensource.google/go/x/xerrors/+/5ec99f83:LICENSE,BSD-3-Clause
gopkg.in/src-d/go-billy.v4,https://github.com/src-d/go-billy/blob/v4.3.2/LICENSE,Apache-2.0
gopkg.in/src-d/go-git.v4,https://github.com/src-d/go-git/blob/v4.13.1/LICENSE,Apache-2.0
gopkg.in/warnings.v0,https://github.com/go-warnings/warnings/blob/v0.1.2/LICENSE,BSD-2-Clause

此命令打印出一个逗号分隔的报告（CSV），列出二进制文件/包使用的库、可以查看其许可证的 URL 以及许可证类型。库被视为共享一个许可证文件的一个或多个 Go 包。

URL 基于 go modules 元数据进行版本控制。

提示：go-licenses 将报告写入 stdout，将信息/警告/错误日志写入 stderr。要在 bash 中将 CSV 保存到文件 licenses.csv，请运行：

go-licenses report github.com/google/go-licenses > licenses.csv

或者，要同时将错误日志保存到 errors 文件，请运行：

go-licenses report github.com/google/go-licenses > licenses.csv 2> errors

注意：一些警告和错误可能是预期的，请参阅警告和错误以获取更多信息。

使用自定义模板的报告

go-licenses report github.com/google/go-licenses --template testdata/modules/hello01/licenses.tpl
W0822 16:56:50.696198   10200 library.go:94] "golang.org/x/sys/unix" 包含无法检查进一步依赖关系的非 Go 代码:
/Users/willnorris/go/pkg/mod/golang.org/x/sys@v0.0.0-20220722155257-8c9f86f7a55f/unix/asm_bsd_arm64.s
/Users/willnorris/go/pkg/mod/golang.org/x/sys@v0.0.0-20220722155257-8c9f86f7a55f/unix/zsyscall_darwin_arm64.1_13.s
/Users/willnorris/go/pkg/mod/golang.org/x/sys@v0.0.0-20220722155257-8c9f86f7a55f/unix/zsyscall_darwin_arm64.s
W0822 16:56:51.466449   10200 library.go:94] "golang.org/x/crypto/chacha20" 包含无法检查进一步依赖关系的非 Go 代码:
/Users/willnorris/go/pkg/mod/golang.org/x/crypto@v0.0.0-20220112180741-5e0467b6c7ce/chacha20/chacha_arm64.s
W0822 16:56:51.475139   10200 library.go:94] "golang.org/x/crypto/curve25519/internal/field" 包含无法检查进一步依赖关系的非 Go 代码:
/Users/willnorris/go/pkg/mod/golang.org/x/crypto@v0.0.0-20220112180741-5e0467b6c7ce/curve25519/internal/field/fe_arm64.s
W0822 16:56:51.602250   10200 library.go:269] 模块 github.com/google/go-licenses 的版本为空，默认为 HEAD。许可证 URL 可能不正确。请验证!
W0822 16:56:51.605074   10200 library.go:269] 模块 github.com/google/go-licenses 的版本为空，默认为 HEAD。许可证 URL 可能不正确。请验证!

 - github.com/emirpasic/gods ([BSD-2-Clause](https://github.com/emirpasic/gods/blob/v1.12.0/LICENSE))
 - github.com/golang/glog ([Apache-2.0](https://github.com/golang/glog/blob/23def4e6c14b/LICENSE))
 - github.com/golang/groupcache/lru ([Apache-2.0](https://github.com/golang/groupcache/blob/41bb18bfe9da/LICENSE))
 - github.com/google/go-licenses ([Apache-2.0](https://github.com/google/go-licenses/blob/HEAD/LICENSE))
 - github.com/google/go-licenses/internal/third_party/pkgsite ([BSD-3-Clause](https://github.com/google/go-licenses/blob/HEAD/internal/third_party/pkgsite/LICENSE))
 - github.com/google/licenseclassifier ([Apache-2.0](https://github.com/google/licenseclassifier/blob/3043a050f148/LICENSE))
 - github.com/google/licenseclassifier/licenses ([Unlicense](https://github.com/google/licenseclassifier/blob/3043a050f148/licenses/Unlicense.txt))
 - github.com/google/licenseclassifier/stringclassifier ([Apache-2.0](https://github.com/google/licenseclassifier/blob/3043a050f148/stringclassifier/LICENSE))
 - github.com/jbenet/go-context/io ([MIT](https://github.com/jbenet/go-context/blob/d14ea06fba99/LICENSE))
 - github.com/kevinburke/ssh_config ([MIT](https://github.com/kevinburke/ssh_config/blob/01f96b0aa0cd/LICENSE))
 - github.com/mitchellh/go-homedir ([MIT](https://github.com/mitchellh/go-homedir/blob/v1.1.0/LICENSE))
 - github.com/otiai10/copy ([MIT](https://github.com/otiai10/copy/blob/v1.6.0/LICENSE))
 - github.com/sergi/go-diff/diffmatchpatch ([MIT](https://github.com/sergi/go-diff/blob/v1.2.0/LICENSE))
 - github.com/spf13/cobra ([Apache-2.0](https://github.com/spf13/cobra/blob/v1.5.0/LICENSE.txt))
 - github.com/spf13/pflag ([BSD-3-Clause](https://github.com/spf13/pflag/blob/v1.0.5/LICENSE))
 - github.com/src-d/gcfg ([BSD-3-Clause](https://github.com/src-d/gcfg/blob/v1.4.0/LICENSE))
 - github.com/xanzy/ssh-agent ([Apache-2.0](https://github.com/xanzy/ssh-agent/blob/v0.2.1/LICENSE))
 - go.opencensus.io ([Apache-2.0](https://github.com/census-instrumentation/opencensus-go/blob/v0.23.0/LICENSE))
 - golang.org/x/crypto ([BSD-3-Clause](https://cs.opensource.google/go/x/crypto/+/5e0467b6:LICENSE))
 - golang.org/x/mod/semver ([BSD-3-Clause](https://cs.opensource.google/go/x/mod/+/86c51ed2:LICENSE))
 - golang.org/x/net ([BSD-3-Clause](https://cs.opensource.google/go/x/net/+/a158d28d:LICENSE))
 - golang.org/x/sys ([BSD-3-Clause](https://cs.opensource.google/go/x/sys/+/8c9f86f7:LICENSE))
 - golang.org/x/tools ([BSD-3-Clause](https://cs.opensource.google/go/x/tools/+/v0.1.12:LICENSE))
 - gopkg.in/src-d/go-billy.v4 ([Apache-2.0](https://github.com/src-d/go-billy/blob/v4.3.2/LICENSE))
 - gopkg.in/src-d/go-git.v4 ([Apache-2.0](https://github.com/src-d/go-git/blob/v4.13.1/LICENSE))
 - gopkg.in/warnings.v0 ([BSD-2-Clause](https://github.com/go-warnings/warnings/blob/v0.1.2/LICENSE))

此命令执行指定的 Go 模板文件以生成许可证报告。模板文件传递一个包含许可证数据的结构体切片：

[]struct {
  Name        string
  Version     string
  LicenseURL  string
  LicenseName string
  LicensePath string
}

每个结构体还有一个 LicenseText 方法，如果存在，它将返回存储在 LicensePath 中的许可证文本，如果不存在，则返回空字符串。

将许可证渲染为 markdown 的模板示例：

{{ range . }}
## {{ .Name }}

* 名称: {{ .Name }}
* 版本: {{ .Version }}
* 许可证: [{{ .LicenseName }}]({{ .LicenseURL }})

```
{{ .LicenseText }}
```
{{ end }}

保存许可证、版权声明和源代码（根据许可证类型）

go-licenses save "github.com/google/go-licenses" --save_path="/tmp/go-licenses-cli"

检查禁止的许可证

$ go-licenses check github.com/logrusorgru/aurora
库 github.com/logrusorgru/aurora 的许可证类型 WTFPL 被禁止
退出状态 1

此命令分析包的依赖项，并确定是否有任何依赖项被许可证分类器认为是禁止的。有关被认为禁止的许可证，请参阅 github.com/google/licenseclassifier。

用法

全局

通常，指定构建 Go 二进制文件的 Go 包。 go-licenses 期望与 go build 相同的包参数格式。例如：

根导入路径，如 github.com/google/go-licenses 或 github.com/google/go-licenses/licenses。
表示该目录中包的相对路径，如 . 或 ./cmd/some-command。

要了解更多关于包参数的信息，请运行 go help packages。要了解更多关于 go-licenses 的用法，请运行 go-licenses help。

报告

生成报告（默认 csv 输出）：

go-licenses report <包> [包...]

生成报告（使用自定义模板文件）：

go-licenses report <包> [包...] --template=<模板文件>

保存

go-licenses save <包> [包...] --save_path=<保存路径>

检查

检查是否使用了禁止和未知的许可证：

go-licenses check <包> [包...]

提示：通常你会想要

在导入路径前缀（例如你的仓库路径）的末尾添加 /... 以包含所有匹配该模式的包
添加 --include_tests 以检查仅被测试代码导入的包（例如测试库/框架）

go-licenses check --include_tests github.com/google/go-licenses/...

检查不允许的许可证类型：

go-licenses check <包> [包...] --disallowed_types=<逗号分隔的许可证类型>

支持的许可证类型：

参见 forbidden 列表：github.com/google/licenseclassifier
参见 notice 列表：github.com/google/licenseclassifier
参见 permissive 列表：github.com/google/licenseclassifier
参见 reciprocal 列表：github.com/google/licenseclassifier
参见 restricted 列表：github.com/google/licenseclassifier
参见 unencumbered 列表：github.com/google/licenseclassifier
unknown

仅允许特定的许可证名称：

go-licenses check <包> [包...] --allowed_licenses=<逗号分隔的许可证名称>

参见支持的许可证名称：github.com/google/licenseclassifier

构建标签

要从带有构建标签的包中读取依赖项，请使用 $GOFLAGS 环境变量。

$ GOFLAGS="-tags=tools" go-licenses report google.golang.org/grpc/test/tools
github.com/BurntSushi/toml,https://github.com/BurntSushi/toml/blob/master/COPYING,MIT
google.golang.org/grpc/test/tools,Unknown,Apache-2.0
honnef.co/go/tools/lint,Unknown,BSD-3-Clause
golang.org/x/lint,Unknown,BSD-3-Clause
golang.org/x/tools,Unknown,BSD-3-Clause
honnef.co/go/tools,Unknown,MIT
honnef.co/go/tools/ssa,Unknown,BSD-3-Clause
github.com/client9/misspell,https://github.com/client9/misspell/blob/master/LICENSE,MIT
github.com/golang/protobuf/proto,https://github.com/golang/protobuf/blob/master/proto/LICENSE,BSD-3-Clause

忽略包

使用 --ignore 全局标志来指定要忽略的包路径前缀。例如，要忽略你组织内部的包 github.com/example-corporation：

$ go-licenses check \
    github.com/example-corporation/example-product \
    --ignore github.com/example-corporation

请注意，被忽略包的依赖项仍会被解析和检查。此标志对 check、report 和 save 命令有效。

包含测试包

使用 --include_tests 全局标志来包含仅被测试代码导入的包（例如测试库/框架）。示例命令：

go-licenses check --include_tests "github.com/google/go-licenses/..."

此标志对 check、report 和 save 命令有效。

警告和错误

该工具在某些情况下会记录警告和错误。本节提供了解决这些问题的指导。

依赖项包含非 Go 代码

当依赖项包含非 Go 代码时，将记录警告。这是因为无法检查非 Go 代码是否存在进一步的依赖项，这可能隐藏了额外的许可证要求。你应该调查这些代码，以确定它是否有依赖项，并采取行动遵守它们的许可条款。

发现 URL 时出错

为了确定可以查看许可证文件的 URL，该工具通常执行以下步骤：

在磁盘上定位许可证文件。
解析 go 模块元数据并找到远程仓库和版本。
将许可证文件路径添加到此 URL。

在某些情况下，该工具可能会找到无效/不正确的 URL 或无法找到 URL。欢迎提出问题。

go-licenses

许可证工具

开始之前

安装

报告

使用自定义模板的报告

保存许可证、版权声明和源代码（根据许可证类型）

检查禁止的许可证

用法

全局

报告

保存

检查

构建标签

忽略包

包含测试包

警告和错误

依赖项包含非 Go 代码

发现 URL 时出错

编辑推荐精选

TRAE编程

蛙蛙写作

问小白

Transly

讯飞智文

讯飞星火

Spark-TTS

咔片PPT

讯飞绘文

材料星

探索AI的无限可能

推荐工具精选

TRAE编程

豆包

讯飞文书

讯飞绘文

讯飞绘镜

阿里绘蛙

咔片PPT

AI云服务特惠

火山引擎

阿里云

腾讯云

华为云

百度智能云

AWS

关注微信公众号