Skip to content

Update README.md #646

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mjherzog wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

Update README.md #646

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 23 additions & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,19 +4,32 @@
[![Test CI](https://github.com/aboutcode-org/scancode-workbench/actions/workflows/Test.yml/badge.svg)](https://github.com/aboutcode-org/scancode-workbench/actions/workflows/Test.yml)
[![Release](https://github.com/aboutcode-org/scancode-workbench/actions/workflows/Release.yml/badge.svg)](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.
ScanCode Workbench provides a visual UI (GUI) to help you quickly evaluate
license, copyright and other important information from a
[ScanCode Toolkit](https://github.com/aboutcode-org/scancode-toolkit/) scan.

The Workbench is a single-user desktop application that works on Windows,
macOS, and Linux operating systems. There is no current or planned future
functionality to edit or update scan results - the Scan data is read-only.

@adaaaam adaaaam Jul 17, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

scan should be lower case


If you need a multi-user application for running or reviewing ScanCode scans,
you should use [ScanCode.io](https://github.com/aboutcode-org/scancode.io)
instead of ScanCode Workbench. You cannot edit scan data in ScanCode.io, but
you can export the scan data in SBOM, XLSX and other formats for further
analysis and processing. You can also import a ScanCode Toolkit scan into
ScanCode.io using the `load_inventory` pipeline.

If you need an application to review and edit ScanCode scan data or to convert
that data into an SBOM or a software inventory, you should use [DejaCode](https://github.com/aboutcode-org/dejacode). You can import scan data from ScanCode Toolkit or ScanCode.io into DejaCode or you can import an SBOM. The DejaCode
Dashboard provides immediate visibility into license or vulnerability issues
related to your products, components and packages. You can use the [DejaCode demo system](https://public.dejacode.com/account/register/) for quick access to its
features and functions.

![ScanCode Workbench](/src/assets/images/workbench_intro.gif)

ScanCode Workbench is based on [Electron](https://www.electronjs.org/).


## Using

- You can
Expand Down
Loading