Skip to content

nexB/scancode-workbench

develop
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

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. ScanCode detects licenses, copyrights and other interesting information in your code.

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