https://github.com/aboutcode-org/scancode-workbench
:bar_chart: ScanCode Workbench is a desktop app to review and conclude license and origin from code scans generated by ScanCode Toolkit.
https://github.com/aboutcode-org/scancode-workbench
oss-compliance scancode scancode-workbench software-licensing
Last synced: 5 months ago
JSON representation
:bar_chart: ScanCode Workbench is a desktop app to review and conclude license and origin from code scans generated by ScanCode Toolkit.
- Host: GitHub
- URL: https://github.com/aboutcode-org/scancode-workbench
- Owner: aboutcode-org
- License: apache-2.0
- Created: 2016-10-13T18:10:59.000Z (over 9 years ago)
- Default Branch: develop
- Last Pushed: 2025-01-17T05:47:11.000Z (about 1 year ago)
- Last Synced: 2025-04-03T22:09:29.568Z (11 months ago)
- Topics: oss-compliance, scancode, scancode-workbench, software-licensing
- Language: TypeScript
- Homepage: https://github.com/nexB/scancode-workbench/releases/latest
- Size: 71.9 MB
- Stars: 166
- Watchers: 21
- Forks: 74
- Open Issues: 35
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.rst
- Contributing: CONTRIBUTING.rst
- Code of conduct: CODE_OF_CONDUCT.rst
- Authors: AUTHORS.rst
Awesome Lists containing this project
README
[](https://github.com/aboutcode-org/scancode-workbench/actions/workflows/Test.yml)
[](https://github.com/aboutcode-org/scancode-workbench/actions/workflows/Release.yml)
ScanCode Workbench provides an advanced visual UI to help you quickly evaluate
license and other notices identified by
[ScanCode](https://github.com/aboutcode-org/scancode-toolkit/).
[ScanCode](https://github.com/aboutcode-org/scancode-toolkit/) detects licenses,
copyrights and other interesting information in your code.
ScanCode Workbench is based on [Electron](https://www.electronjs.org/) and will
be the primary desktop/GUI tool for using nexB’s
[AboutCode tools](https://github.com/nexB/aboutcode). This app works on Windows,
macOS and Linux operating systems.
## Using
- You can
[download the latest release](https://github.com/aboutcode-org/scancode-workbench/releases)
for your operating system or build it yourself (see below). Once downloaded,
you can find `ScanCode-Workbench` under
`dist/ScanCode-Workbench---`
- ScanCode Workbench >= v4 is only compatible with scans from
[ScanCode v32.0.0](https://github.com/aboutcode-org/scancode-toolkit/releases)
and above which are run with the ScanCode `-i` option. For a list of available
ScanCode options see
[How To: Set what will be detected in a scan](https://scancode-toolkit.readthedocs.io/en/latest/tutorials/how_to_set_what_will_be_detected_in_a_scan.html)
```bash
scancode -clipeu
```
- 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/aboutcode-org/scancode-workbench/tree/develop/samples](https://github.com/aboutcode-org/scancode-workbench/tree/develop/samples).
- Import a ScanCode JSON file, and see what components are in your software! See
the [documentation](https://scancode-workbench.readthedocs.io) for more
information on how to use ScanCode Workbench.
[Import a JSON file](https://scancode-workbench.readthedocs.io/en/latest/how-to-guides/load-your-data/import-json.html)
## Running locally
You'll need [Node.js](https://nodejs.org) (which comes with
[npm](http://npmjs.com)) installed on your computer in order to build this app.
For a list of platform specific requirements, see the Building section of the
[documentation](https://scancode-workbench.readthedocs.io/en/latest/contribute/building.html).
Then, from your command line:
```bash
# Clone this repository
$ git clone https://github.com/aboutcode-org/scancode-workbench.git
# Go into the repository
$ cd scancode-workbench
# Install dependencies and run the app
$ npm install
# Run the app
$ npm start
```
## Release Instructions
You'll need python 3.x to run the build. You can build a `dist` directory
containing executables for your platform
Note: Due to usage of native modules, a build must be done on target platform
only.
```bash
$ npm run publish
```
You can find the executible `ScanCode-Workbench-` inside
`out/ScanCode-Workbench---` and distributable archive
(.tar.gz or .zip) in `dist/`
## Testing
Run tests using:
```bash
$ 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.
[](https://matrix.to/#/#aboutcode-org_scancode-workbench:gitter.im)
For questions and chats, you can join the Gitter channel at
https://matrix.to/#/#aboutcode-org_scancode-workbench:gitter.im