ScanCode Workbench provides an advanced visual UI to help you quickly evaluate license and other notices identified by ScanCode and record your conclusion about the effective license(s) for a component. ScanCode detects licenses, copyrights and other interesting information in your code. ScanCode Workbench allows you to take the scan results from ScanCode and create conclusions. By creating these conclusions within your codebase, you are creating a software inventory of your product. The conclusions (Concluded License, Concluded Owner, etc.) you make when creating your conclusion can be exported as a JSON file or saved as SQLite file.
- You can download the latest release
for your operating system or build it yourself (see below). Once downloaded, you
- ScanCode Workbench >= v2 is only compatible with scans from
ScanCode v2.0.0 and
above which are run with the ScanCode
-ioption. For a list of available ScanCode options see How To: Set what will be detected in a scan
./scancode -clipeu <input> <output_file>
- We have provided a set of sample scans that you can quickly review in ScanCode Workbench in order to get a sense of its functionality and the types of information captured by a scan. The samples are located at https://github.com/nexB/scancode-workbench/tree/develop/samples.
- Import a ScanCode JSON file, and see what components are in your software! See the wiki for more documentation on how to use ScanCode Workbench.
You'll need Node.js (which comes with npm) installed on your computer in order to build this app. For a list of platform specific requirements, see the Building section of the wiki. Then, from your command line:
# Clone this repository git clone https://github.com/nexB/scancode-workbench.git # Go into the repository cd scancode-workbench # Install dependencies and run the app npm install # Rebuild native Node.js modules against the app version of Node.js # MacOS, Linux and Git Bash on Windows $(npm bin)/electron-rebuild # Windows except for Git Bash .\node_modules\.bin\electron-rebuild.cmd # Run the app npm start
You can build a
dist directory containing executables for any one of three
target platforms by running:
$ python build.py
After building is done, you can find
dist/ScanCode-Workbench-<os>-x64-<version>. Archives (tar.gz and .zip) are
Note: A build for any of the three target platforms must be executed on the targeted platform.
Test ABCM functionality using:
$ npm test
- Multiple licenses (LGPL, MIT, BSD, etc.) for third-party components.
See the NOTICE file for more details.
If you have a question, a suggestion or find a bug, enter an issue.
For questions and chats, you can join the Gitter channel at https://gitter.im/aboutcode-org/discuss