Introduction
The OSS Review Toolkit (ORT) is a FOSS policy automation and orchestration toolkit that you can use to manage your (open source) software dependencies in a strategic, safe and efficient manner.
You can use it to:
- Generate CycloneDX, SPDX SBOMs, or custom FOSS attribution documentation for your software project
- Automate your FOSS policy using risk-based Policy as Code to do licensing, security vulnerability, InnerSource and engineering standards checks for your software project and its dependencies
- Create a source code archive for your software project and its dependencies to comply with certain licenses or have your own copy as nothing on the internet is forever
- Correct package metadata or licensing findings yourself, using InnerSource or with the help of the FOSS community
ORT can be used as a library (for programmatic use), via a command line interface (for scripted use), or via its CI integrations.
It consists of the following tools which can be combined into a highly customizable pipeline:
- Analyzer:
Determines the dependencies of projects and their metadata, abstracting which package managers or build systems are actually being used.
- Downloader:
Fetches all source code of the projects and their dependencies, abstracting which Version Control System (VCS) or other means are used to retrieve the source code.
- Scanner:
Uses configured source code scanners to detect license / copyright findings, abstracting the type of scanner.
- Advisor:
Retrieves security advisories for used dependencies from configured vulnerability data services.
- Evaluator:
Evaluates custom policy rules along with custom license classifications against the data gathered in preceding stages and returns a list of policy violations, e.g. to flag license findings.
- Reporter:
Presents results in various formats such as visual reports, Open Source notices or Bill-Of-Materials (BOMs) to easily identify dependencies, licenses, copyrights or policy rule violations.
- Notifier:
Sends result notifications via different channels (like emails and / or JIRA tickets).
Also see the list of related tools that help with running ORT.
Documentation
For detailed information, see the documentation on the ORT Website.
If you have further questions, reach out to the ORT community on Slack or contact the team by email.
Installation
System requirements
ORT is being continuously used on Linux, Windows and macOS by the core development team, so these operating systems are considered to be well-supported.
To run the ORT binaries (also see Installation from binaries) at least Java 25 is required.
Memory and CPU requirements vary depending on the size and type of project(s) to analyze / scan, but the general recommendation is to configure Java with 8 GiB of memory and to use a CPU with at least 4 cores.
# This will give the Java Virtual Machine 8GB Memory.
export JAVA_OPTS="$JAVA_OPTS -Xmx8g"
If ORT requires external tools to analyze a project, these tools are listed by the ort requirements command.
If a package manager is not listed there, support for it is integrated directly into ORT and does not require any external tools to be installed.
From binaries
CLI distribution
Head over to the releases page.
From the "Assets" section of your chosen release, download the distribution archive of the desired type.
Typically that is .zip for Windows and .tgz otherwise; but the contents of the archives are the same.
The ort-* archives contain the ORT main distribution, while the orth-* archives contain the ORT helper distribution.
Unpack the archive to an installation directory.
The scripts to run ORT are located at bin/ort and bin\ort.bat, or bin/orth and bin\orth.bat, respectively.
Docker distribution
In addition to the CLI, ORT is also distributed as a Docker image that contains all tools required by ORT (see the ort requirements command).
To run ORT from the latest version of that image (which will be downloaded if needed) use:
This is the beginning of the README. Read the rest at the original. Read the full README ↗
