Logo
Project Icon

go-licenses

Go 项目许可证分析与合规管理工具

go-licenses开源许可依赖分析许可证报告合规性检查Github开源项目

go-licenses 是一款专为 Go 项目设计的开源许可证分析工具。它能够分析依赖树、生成许可证报告、检查许可证合规性并收集必要文件。该工具简化了许可证管理流程，帮助开发者确保项目符合开源合规要求。go-licenses 支持多种功能，包括许可证报告生成、合规性检查和相关文件收集，为 Go 项目的开源管理提供了全面的解决方案。

访问官网访问官网GithubGithub文档文档
介绍相关项目

许可证工具

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

go-licenses 分析 Go 包/二进制文件的依赖树。它可以输出关于使用的库以及可以在何种许可下使用它们的报告。它还可以将所有许可文档、版权声明和源代码收集到一个目录中，以符合重新分发的许可条款。

开始之前

要使用此工具，请确保：

  • 已安装 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"

此命令分析二进制文件/包的依赖项，并确定需要与该二进制文件/包一起重新分发的内容，以符合许可条款。这通常包括许可证本身和版权声明，但也可能包括依赖项的源代码。所有必需的文件将保存在 --save_path 指定的目录中。

检查禁止的许可证

$ 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=<逗号分隔的许可证类型>

支持的许可证类型：

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

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

构建标签

要从带有构建标签的包中读取依赖项，请使用 $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，该工具通常执行以下步骤：

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

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

相关项目
项目侧边栏1项目侧边栏2
推荐项目
Project Cover

豆包MarsCode

豆包 MarsCode 是一款革命性的编程助手，通过AI技术提供代码补全、单测生成、代码解释和智能问答等功能，支持100+编程语言，与主流编辑器无缝集成，显著提升开发效率和代码质量。

Project Cover

AI写歌

Suno AI是一个革命性的AI音乐创作平台，能在短短30秒内帮助用户创作出一首完整的歌曲。无论是寻找创作灵感还是需要快速制作音乐，Suno AI都是音乐爱好者和专业人士的理想选择。

Project Cover

有言AI

有言平台提供一站式AIGC视频创作解决方案，通过智能技术简化视频制作流程。无论是企业宣传还是个人分享，有言都能帮助用户快速、轻松地制作出专业级别的视频内容。

Project Cover

Kimi

Kimi AI助手提供多语言对话支持，能够阅读和理解用户上传的文件内容，解析网页信息，并结合搜索结果为用户提供详尽的答案。无论是日常咨询还是专业问题，Kimi都能以友好、专业的方式提供帮助。

Project Cover

阿里绘蛙

绘蛙是阿里巴巴集团推出的革命性AI电商营销平台。利用尖端人工智能技术，为商家提供一键生成商品图和营销文案的服务，显著提升内容创作效率和营销效果。适用于淘宝、天猫等电商平台，让商品第一时间被种草。

Project Cover

吐司

探索Tensor.Art平台的独特AI模型，免费访问各种图像生成与AI训练工具，从Stable Diffusion等基础模型开始，轻松实现创新图像生成。体验前沿的AI技术，推动个人和企业的创新发展。

Project Cover

SubCat字幕猫

SubCat字幕猫APP是一款创新的视频播放器，它将改变您观看视频的方式！SubCat结合了先进的人工智能技术，为您提供即时视频字幕翻译，无论是本地视频还是网络流媒体，让您轻松享受各种语言的内容。

Project Cover

美间AI

美间AI创意设计平台，利用前沿AI技术，为设计师和营销人员提供一站式设计解决方案。从智能海报到3D效果图，再到文案生成，美间让创意设计更简单、更高效。

Project Cover

AIWritePaper论文写作

AIWritePaper论文写作是一站式AI论文写作辅助工具，简化了选题、文献检索至论文撰写的整个过程。通过简单设定，平台可快速生成高质量论文大纲和全文，配合图表、参考文献等一应俱全，同时提供开题报告和答辩PPT等增值服务，保障数据安全，有效提升写作效率和论文质量。

使用协议隐私政策广告服务
投诉举报邮箱: service@vectorlightyear.com
@2024 懂AI·鲁ICP备2024100362号-6·鲁公网安备37021002001498号