#spdx #licensing #command-line-tool #cli

应用 spdx-guide

一款帮助您在项目中创建 spdx 文件的工具

5 个版本

0.2.3 2022 年 10 月 12 日
0.2.2 2022 年 9 月 30 日
0.1.2 2022 年 9 月 30 日
0.1.1 2022 年 9 月 29 日
0.1.0 2022 年 9 月 29 日

#1660开发工具

GPL-3.0-or-later

39KB
779

spdx-guide

spdx-guide 是一个超级简单的命令行工具,帮助您开始创建简单的 SPDX 文件。

asciicast

什么是 SPDX?

SPDX 是一种指定软件许可证和创建软件物料清单 (SBOM) 的标准,这些清单以机器可读的格式提供软件及其依赖项的许可证信息。将 SPDX 文件添加到您的项目中,尤其是到您的库中,有助于他人并有助于实现修复当前开源许可证混乱状态的更大目标。

spdx-guide 的目标

该软件专门创建,以便从未使用过或听说过 SPDX 的人为他们的项目创建 SPDX 文件。spdx-guide 将通过直观的命令行对话框引导您完成创建过程。

存在用于与 SPDX 框架一起工作的工具,但据我所知,它们都没有针对完全初学者或想要改善他们的许可证状况但不想花大量时间记忆规范或配置他们的构建工具的人。

简而言之,该软件的目标是

  • 使不知道任何关于 SPDX 的人能够为他们的项目创建 SPDX 文件
  • 为更高级的用户提供一种工具,可以创建一个简单的 SPDX 文件,稍后可以扩展为更复杂的工具

非目标

spdx-guide 不会(目前)

  • 处理您项目的依赖项
  • 执行许可证检测或分析
  • 为您的发行版创建完整的 SBOM
  • 提供法律建议
  • 为您选择许可证

使用方法

只需在您的项目目录中运行 spdx-guide。有关更多信息,请参阅 spdx-guide --help

安装

通过 Cargo

运行 cargo install spdx-guide。可执行文件将最终位于 ~/.cargo/bin/,因此如果它在您的 PATH 中,您将能够从任何地方使用应用程序。

许可证

spdx-guide 是免费软件,并受 GNU 通用公共许可证版本 3.0 或任何后续版本的许可。

依赖项

~18–28MB
~453K SLoC