tools-java
SPDX Command Line Tools using the Spdx-Java-Library
File Explorer
Download Latest Version (.zip)- build.yml
- docker_deploy.yml
- docs.yml
- dependabot.yml
- ExistingSpdxDocumentV2Compat.java
- ExpandedLicenseExampleV3.java
- FullSpdxV3Example.java
- SimpleSpdxDocumentV2Compat.java
- SpdxExtensionExample.java
- log4j2.xml
- spdx-schema-v2.2.json
- spdx-schema-v2.3.json
- spdx-schema-v3.0.0.json
- spdx-schema-v3.0.1.json
- tools-java-wrapper.sh
- AbstractFileCompareSheet.java
- AbstractSheet.java
- CompareHelper.java
- CreatorSheet.java
- DocumentAnnotationSheet.java
- DocumentRelationshipSheet.java
- DocumentSheet.java
- ExternalReferencesSheet.java
- ExtractedLicenseSheet.java
- FileAnnotationSheet.java
- FileAttributionSheet.java
- FileChecksumSheet.java
- FileCommentSheet.java
- FileConcludedSheet.java
- FileContributorsSheet.java
- FileCopyrightSheet.java
- FileLicenseCommentsSheet.java
- FileLicenseInfoSheet.java
- FileNoticeSheet.java
- FileRelationshipSheet.java
- FileSpdxIdSheet.java
- FileTypeSheet.java
- MultiDocumentSpreadsheet.java
- NormalizedFileNameComparator.java
- package-info.java
- PackageSheet.java
- SnippetSheet.java
- VerificationSheet.java
- AbstractOwlRdfConverter.java
- OwlToJsonContext.java
- OwlToJsonSchema.java
- OwlToXsd.java
- package-info.java
- SchemaException.java
- CompareSpdxDocs.java
- ExitCode.java
- GenerateVerificationCode.java
- InvalidFileNameException.java
- Main.java
- MatchingStandardLicenses.java
- OnlineToolException.java
- RdfSchemaToJsonContext.java
- RdfSchemaToJsonSchema.java
- RdfSchemaToXsd.java
- SpdxConverter.java
- SpdxConverterException.java
- SpdxToolsHelper.java
- SpdxVerificationException.java
- SpdxVersion.java
- SpdxViewer.java
- Verify.java
- project.properties
- OwlToJsonContextTest.java
- OwlToJsonSchemaTest.java
- OwlToXSDTest.java
- CompareSpdxDocsTest.java
- GenerateVerificationCodeTest.java
- LatestSchemaVersionTest.java
- MatchingStandardLicensesTest.java
- SpdxConverterTestV2.java
- SpdxConverterTestV3.java
- VerifyTest.java
- AbstractFileCompareSheet.java
- AbstractSheet.java
- CompareHelper.java
- CreatorSheet.java
- DocumentAnnotationSheet.java
- DocumentRelationshipSheet.java
- DocumentSheet.java
- ExternalReferencesSheet.java
- ExtractedLicenseSheet.java
- FileAnnotationSheet.java
- FileAttributionSheet.java
- FileChecksumSheet.java
- FileCommentSheet.java
- FileConcludedSheet.java
- FileContributorsSheet.java
- FileCopyrightSheet.java
- FileLicenseCommentsSheet.java
- FileLicenseInfoSheet.java
- FileNoticeSheet.java
- FileRelationshipSheet.java
- FileSpdxIdSheet.java
- FileTypeSheet.java
- MultiDocumentSpreadsheet.java
- NormalizedFileNameComparator.java
- package-info.java
- PackageSheet.java
- SnippetSheet.java
- VerificationSheet.java
- BadJSON.spdx.json
- DifferentFileComment.spdx.yaml
- double.jsonld
- spdx-2-2-revision-8-ontology.owl.xml
- SPDXJSONExample-v2.2.spdx.json
- SPDXJSONExample-v2.3-with-exception.spdx.json
- SPDXJSONExample-v2.3.spdx.json
- SPDXJSONExample-wrongversion.spdx.json
- SPDXJsonLDExample-v3.0.1.json
- SPDXRdfExample-v2.2.spdx.rdf
- SPDXRdfExample-v2.3.spdx.rdf
- SPDXSpreadsheetExample-v2.2.xls
- SPDXSpreadsheetExample-v2.2.xlsx
- SPDXSpreadsheetExample-v2.3.xls
- SPDXSpreadsheetExample-v2.3.xlsx
- SPDXTagExample-v2.2-warning.spdx
- SPDXTagExample-v2.2.spdx
- SPDXTagExample-v2.3.spdx
- SPDXWrongVersion.spdx.json
- SPDXXMLExample-v2.2.spdx.xml
- SPDXXMLExample-v2.3.spdx.xml
- SPDXYAMLExample-2.2.spdx.yaml
- SPDXYAMLExample-2.3.spdx.yaml
- .gitignore
- CONTRIBUTING.md
- dependency-check-supress.xml
- Dockerfile
- LICENSE
- pom.xml
- README.md
- RELEASE-CHECKLIST.md
- tools-java.iml
# Installation Guide
1. Get the code
git clone https://github.com/spdx/tools-java
Downloads the entire project code from GitHub to your computer.
cd tools-java
Moves into the project folder you just downloaded.
2. Docker
Easy RecommendedPrerequisites
- Git Needed to download the project code from GitHub.
- Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker build -t tools-java .
Builds a runnable image based on the Dockerfile.
docker run -p 8080:80 tools-java
Runs the built image as an actual container.
Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.
3. Maven (Java)
MediumPrerequisites
- Git Needed to download the project code from GitHub.
- JDK (Java) Required to build and run Java projects.
- Maven The build tool used for the mvn command.
mvn clean install
Installs dependencies and builds the project using Maven.
A BUILD SUCCESS message means it worked. The output is created under target/.
Pulled directly from this repo's README.
// repository documentation
Was this content helpful?
(0 ratings)
