source

spdx_tool

1.0.0

SPDX license detection and management tool

GitHubRepository Community CIResults All crate versions Download JSON

1.0.0

spdx-tool scans the source files to identify licenses and allows to update them in order to use the SPDX license format. It can be used to:

  • identify the license used in source files of a project,
  • produce a JSON/XML report for the licenses found with the list of files,
  • replace a license header by the SPDX license tag equivalent.

Identify licenses used in a project:

spdx-tool

Identify files matching a given license:

spdx-tool --only-licenses=Apache-2.0 -f

Check the license header before replacing it:

spdx-tool --only-licenses=Apache-2.0 --print-license --line-number src

Replace the license header by the SPDX-License-Identifier header:

spdx-tool --only-licenses=Apache-2.0 --update=spdx src

Build an XML or JSON report of files with their licenses:

spdx-tool --output-xml=report.xml

Documentation

Authors
ciceron
Maintainers
ciceron <Stephane.Carrez@gmail.com>
Maintainer profiles
@stcarrez
Licenses
Apache-2.0
Website
https://github.com/stcarrez/spdx-tool
Repository
gitlab.com/stcarrez/spdx-tool
Source revision
a2c70523a2c7
Tags
tools, spdx, license
Project files
spdx_tool.gpr
Executables
spdx-tool
Manifest
index/sp/spdx_tool/spdx_tool-1.0.0.toml
Build and platform metadata 2 fields
GPR values
{
  "case(os)": {
    "freebsd": {
      "USE_MAGICADA": "no"
    },
    "linux": {
      "USE_MAGICADA": "yes"
    },
    "macos": {
      "USE_MAGICADA": "no"
    },
    "windows": {
      "USE_MAGICADA": "no"
    }
  }
}
Actions
[
  {
    "command": [
      "sh",
      "./alire-setup.sh"
    ],
    "type": "post-fetch"
  }
]