Skip to content

Latest commit

 

History

History
50 lines (33 loc) · 2.19 KB

README.md

File metadata and controls

50 lines (33 loc) · 2.19 KB
Raw

SCANOSS Open Source Inventory Engine

THE FIRST OPEN SOURCE INVENTORY ENGINE BUILT FOR DEVELOPERS

SCANOSS is an open, configurable OSS inventory engine that was built specifically for developers, empowering them to confidently produce compliant code from the moment they begin writing, while delivering greater license and usage visibility for the broader DevOps team and supply chain partners.

With its open architecture that is easy to integrate into existing processes and toolchains, SCANOSS transforms software bill of materials (SBOM) creation from ‘write now, audit later’ to an always-on analysis of live code.

By freeing developers to focus on writing great, compliant code that they and their team can completely trust, applications are finished earlier, quality is consistently higher, and development costs are dramatically lower.

Installation

The SCANOSS Inventory Engine a command-line tool used for comparing a file or directory against the SCANOSS Knowledgebase. The source code can be downloaded and compiled as follows:

wget -O engine.zip https://github.com/scanoss/engine/archive/master.zip
unzip engine.zip
cd engine-master
make
sudo make install
cd ..
scanoss -v

The last command should show the installed version of the SCANOSS Inventory Engine.

Usage

This program performs an OSS inventory for the given TARGET comparing against the ScanOSS LDB Knowledgebase. Results are printed in STDOUT in JSON format. You can create your own knowledgebase with the minr command, available at https://github.com/scanoss/minr

Syntax: scanoss [parameters] [TARGET]

Configuration:

  • -w Treats TARGET as a .wfp file regardless of the actual file extension
  • -s FILE Use assets specified in the provided JSON SBOM (CycloneDX/SPDX2.2 JSON format) as input to identification
  • -b FILE Blacklist matches to assets specified in the provided JSON SBOM (CycloneDX/SPDX2.2 JSON format)

Options:

  • -t Tests engine performance
  • -v Display version and exit
  • -h Display this help and exit
  • -d Enable debugging information

License

The Scanoss Open Source Inventory Engine is released under the GPL 2.0 license. Please check the LICENSE file for more information.

Copyright (C) 2018-2020 SCANOSS.COM