Skip to content
📊 ScanCode Workbench is a desktop app to review and conclude license and origin from code scans generated by ScanCode Toolkit.
HTML JavaScript CSS Python
Branch: develop
Clone or download
Latest commit 159742b Jan 6, 2020
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
assets Remove the ability to upload Conclusions to DejaCode #413 Jan 6, 2020
docs Remove the ability to upload Conclusions to DejaCode #413 Jan 6, 2020
samples Update sample scanfiles to newer scancode version Aug 31, 2018
test Add ability to view full scan headers Nov 14, 2019
.eslintrc.json Refactor to use parens around all arguments #168 Jan 31, 2018
.gitattributes Add .gitattributes Aug 6, 2018
.gitignore Add source-controlled documentation Dec 16, 2019
.travis.yml Add source-controlled documentation Dec 16, 2019
CHANGELOG.rst Update CHANGELOG.rst for issue #413 Jan 6, 2020
ISSUE_TEMPLATE.md Update Help documentation in app Dec 18, 2019
LICENSE Add c3.js charts to dashboard #99 Oct 10, 2017
NOTICE Rename AboutCode Manager to ScanCode Workbench Jan 4, 2019
README.md Update Help documentation in app Dec 18, 2019
about.html Rename AboutCode Manager to ScanCode Workbench Jan 4, 2019
appveyor.yml Update Appveyor settings Sep 30, 2019
attribution.html bump version Sep 27, 2019
bower.json Rename AboutCode Manager to ScanCode Workbench Jan 4, 2019
build.py Create icons using vector layer #382 Dec 3, 2019
deploy_rsa.enc SCP dist to deploy host #16 Aug 7, 2017
index.html Remove the ability to upload Conclusions to DejaCode #413 Jan 6, 2020
main.js Update Help documentation in app Dec 18, 2019
package-lock.json
package.json Fix failing test suite by adding globby dev dependency Sep 30, 2019
workbench.ABOUT bump version Sep 27, 2019

README.md

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

Using

./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 documentation for more information on how to use ScanCode Workbench.

Import a JSON file

Building

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 documentation. 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

Release Instructions

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

Testing

Test ABCM functionality using:

$ npm test

License

  • Apache-2.0
  • Multiple licenses (LGPL, MIT, BSD, etc.) for third-party components.

See the NOTICE file for more details.

Support

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 https://gitter.im/aboutcode-org/discuss

You can’t perform that action at this time.