Download and Install¶
You can download the latest ScanCode Workbench release for your Windows, OS X or Linux operating system from the ScanCode Workbench releases page. Once downloaded, you’ll find the ScanCode Workbench executable in the
ScanCode-Workbench-<os>-x64-<version>folder. On Windows 10, for example, the executable will be named ScanCode-Workbench.exe.
If you’re interested in digging into the code, you can also use ScanCode Workbench by cloning the GitHub repository and building it yourself – see the Contribute/Building section for details.
ScanCode Workbench-ScanCode Toolkit Compatibility¶
ScanCode Workbench >= v3.1.1 is only compatible with scans from ScanCode v3.1.1 and above that have been run with the ScanCode Toolkit
A list of available ScanCode Toolkit options is available in the ScanCode Toolkit documentation: How to set what will be detected in Scan.
You would typically create your scan with the following command:
./scancode -clipeu <input> <output_file>
Open ScanCode Workbench and Load a ScanCode Toolkit Scan¶
Double-click the ScanCode Workbench executable you downloaded. You’ll probably want to maximize the application once it has opened.
Import your JSON scan file and save it as a SQLite file (ScanCode Workbench works with the data in a SQLite database).
File > Import JSON File (Ctrl + I) ==> opens
Open a JSON Filewindow.
Select your JSON scan and click Open ==> opens
Save a SQLite Database Filewindow.
Keep or modify the default SQLite filename and click Save.
You’re now looking at your scan data displayed in the Table View – the Table View itself is on the right, and the Directory Tree (which is visible in all views) is on the left.
You can find additional details in the How-To Guides section below.