Scancode Workbench

Scancode Workbench

It helps to quickly evaluate licenses and notices and record your conclusions.

ScanCode Workbench

Travis Build Status AppVeyor Build Status

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.

ScanCode Workbench is based on Electron and will be the primary desktop/GUI tool for using nexB’s AboutCode tools. This app works on Windows, OS X and Linux operating systems.

ScanCode Workbench


./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
  • 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.

Import a JSON file


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

# 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

# Run the app
npm start

Release instructions

You can build a dist directory containing executables for any one of three target platforms by running:

$ python

After building is done, you can find ScanCode-Workbench under dist/ScanCode-Workbench-<os>-x64-<version>. Archives (tar.gz and .zip) are also built.

Note: A build for any of the three target platforms must be executed on the targeted platform.


Test ABCM functionality using:

$ npm test


  • Apache-2.0
  • 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.

Gitter chat

For questions and chats, you can join the Gitter channel at

Chart Summary Chart Summary
Import JSON File Import JSON File

Something missing? Edit this app.

Keyboard Shortcuts

Key Action
/ Focus the search bar
Esc Focus the search bar and cleans it
Select the next search result
Select the previous search result
Enter Open the selected search result
cmdEnter Ctrl+Enter Open the selected search result in a new tab