Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update README.md to version 1.1.8 #152

Merged
merged 1 commit into from
Jan 18, 2024
Merged

Update README.md to version 1.1.8 #152

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 12 additions & 12 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Non-security related issues should be added to the [SPDX tools issues list](http
## Syntax
The command line interface of the spdx tools can be used like this:

java -jar tools-java-1.1.5-jar-with-dependencies.jar <function> <parameters>
java -jar tools-java-1.1.8-jar-with-dependencies.jar <function> <parameters>

## SPDX format converters
The following converter tools support spdx format:
Expand All @@ -45,11 +45,11 @@ The following converter tools support spdx format:

Example to convert a SPDX file from tag to rdf format:

java -jar tools-java-1.1.5-jar-with-dependencies.jar Convert ../testResources/SPDXTagExample-v2.2.spdx TagToRDF.rdf
java -jar tools-java-1.1.8-jar-with-dependencies.jar Convert ../testResources/SPDXTagExample-v2.2.spdx TagToRDF.rdf

The file formats can optionally be provided as the 3rd and 4th parameter for the input and output formats respectively. An optional 5th option `excludeLicenseDetails` will not copy the listed license properties to the output file. The following example will copy a JSON format to an RDF Turtle format without including the listed license properties:

java -jar tools-java-1.1.5-jar-with-dependencies.jar Convert ../testResources/SPDXTagExample-v2.2.spdx TagToRDF.ttl TAG RDFTTL excludeLicenseDetails
java -jar tools-java-1.1.8-jar-with-dependencies.jar Convert ../testResources/SPDXTagExample-v2.2.spdx TagToRDF.ttl TAG RDFTTL excludeLicenseDetails

## Compare utilities
The following tools can be used to compare one or more SPDX documents:
Expand All @@ -58,13 +58,13 @@ The following tools can be used to compare one or more SPDX documents:

Example to compare multiple SPDX files provided in rdf format and provide a spreadsheet with the results:

java -jar tools-java-1.1.5-jar-with-dependencies.jar CompareDocs output.xlsx doc1 doc2 ... docN
java -jar tools-java-1.1.8-jar-with-dependencies.jar CompareDocs output.xlsx doc1 doc2 ... docN

* CompareMultipleSpdxDocs with directory

Example to compare all SPDX documents in a directory "/home/me/spdxdocs" and provide a spreadsheet with the results:

java -jar tools-java-1.1.5-jar-with-dependencies.jar CompareDocs output.xlsx /home/me/spdxdocs
java -jar tools-java-1.1.8-jar-with-dependencies.jar CompareDocs output.xlsx /home/me/spdxdocs

## SPDX Viewer
The following tool can be used to "Pretty Print" an SPDX document.
Expand All @@ -73,7 +73,7 @@ The following tool can be used to "Pretty Print" an SPDX document.

Sample usage:

java -jar tools-java-1.1.5-jar-with-dependencies.jar SPDXViewer ../testResources/SPDXRdfExample-v2.2.spdx.rdf
java -jar tools-java-1.1.8-jar-with-dependencies.jar SPDXViewer ../testResources/SPDXRdfExample-v2.2.spdx.rdf

## Verifier
The following tool can be used to verify an SPDX document:
Expand All @@ -82,19 +82,19 @@ The following tool can be used to verify an SPDX document:

Sample usage:

java -jar tools-java-1.1.5-jar-with-dependencies.jar Verify ../testResources/SPDXRdfExample-v2.2.spdx.rdf
java -jar tools-java-1.1.8-jar-with-dependencies.jar Verify ../testResources/SPDXRdfExample-v2.2.spdx.rdf

## Generators
The following tool can be used to generate an SPDX verification code from a directory of source files:

* GenerateVerificationCode sourceDirectory

Sample usage:

java -jar tools-java-1.1.5-jar-with-dependencies.jar GenerateVerificationCode sourceDirectory [ignoredFilesRegex]
java -jar tools-java-1.1.8-jar-with-dependencies.jar GenerateVerificationCode sourceDirectory [ignoredFilesRegex]

## SPDX Validation Tool
The SPDX Workgroup provides an online interface to validate, compare, and convert SPDX documents in addition to the command line options above. The [SPDX Validation Tool](https://tools.spdx.org/app/validate/) is an all-in-one portal to upload and parse SPDX documents for validation, comparison and conversion and search the SPDX license list.
The SPDX Workgroup provides an online interface to validate, compare, and convert SPDX documents in addition to the command line options above. The [SPDX Validation Tool](https://tools.spdx.org/app/validate/) is an all-in-one portal to upload and parse SPDX documents for validation, comparison and conversion and search the SPDX license list.

# License
A complete SPDX file is available including dependencies is available in the bintray and Maven repos.
Expand Down
Loading