Skip to content

Commit

Permalink
docs(analyzer): Explain that the analyzer is required to run
Browse files Browse the repository at this point in the history
Signed-off-by: Sebastian Schuberth <sebastian@doubleopen.org>
  • Loading branch information
sschuberth committed Aug 28, 2024
1 parent 4841e02 commit 38c9efd
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions website/docs/tools/analyzer.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ sidebar_position: 1
# Analyzer

The *analyzer* is a Software Composition Analysis (SCA) tool that determines the dependencies of software projects inside the specified version-controlled input directory (`-i`).
It is the only mandatory tool to run from ORT as its output is the input for all other tools.
It does so by querying the detected package managers; **no modifications** to your existing project source code, like applying build system plugins, are necessary for that to work.
The tree of transitive dependencies per project is written out as part of an [OrtResult](https://github.com/oss-review-toolkit/ort/blob/main/model/src/main/kotlin/OrtResult.kt) in YAML (or JSON, see `-f`) format to a file named `analyzer-result.yml` in the specified output directory (`-o`).
The output file exactly documents the status quo of all package-related metadata.
Expand Down

0 comments on commit 38c9efd

Please sign in to comment.