{"id":20325855,"url":"https://github.com/aboutcode-org/scancode-workbench","last_synced_at":"2025-10-13T22:07:50.704Z","repository":{"id":12956478,"uuid":"70834613","full_name":"aboutcode-org/scancode-workbench","owner":"aboutcode-org","description":":bar_chart: ScanCode Workbench is a desktop app to review and conclude license and origin from code scans generated by ScanCode Toolkit.","archived":false,"fork":false,"pushed_at":"2025-01-17T05:47:11.000Z","size":75381,"stargazers_count":166,"open_issues_count":35,"forks_count":74,"subscribers_count":21,"default_branch":"develop","last_synced_at":"2025-04-03T22:09:29.568Z","etag":null,"topics":["oss-compliance","scancode","scancode-workbench","software-licensing"],"latest_commit_sha":null,"homepage":"https://github.com/nexB/scancode-workbench/releases/latest","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/aboutcode-org.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.rst","contributing":"CONTRIBUTING.rst","funding":null,"license":null,"code_of_conduct":"CODE_OF_CONDUCT.rst","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":"AUTHORS.rst","dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-10-13T18:10:59.000Z","updated_at":"2025-03-27T06:03:26.000Z","dependencies_parsed_at":"2023-10-16T21:51:40.932Z","dependency_job_id":"88b9b2a6-093d-4401-a442-0fa279af26b5","html_url":"https://github.com/aboutcode-org/scancode-workbench","commit_stats":null,"previous_names":["aboutcode-org/scancode-workbench"],"tags_count":33,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aboutcode-org%2Fscancode-workbench","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aboutcode-org%2Fscancode-workbench/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aboutcode-org%2Fscancode-workbench/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aboutcode-org%2Fscancode-workbench/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/aboutcode-org","download_url":"https://codeload.github.com/aboutcode-org/scancode-workbench/tar.gz/refs/heads/develop","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248618262,"owners_count":21134200,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["oss-compliance","scancode","scancode-workbench","software-licensing"],"created_at":"2024-11-14T19:42:04.852Z","updated_at":"2025-10-13T22:07:45.647Z","avatar_url":"https://github.com/aboutcode-org.png","language":"TypeScript","readme":"\u003cp align=\"center\"\u003e\u003cimg src=\"src/assets/images/scancode-workbench-logo.png\" align=\"center\" alt=\"ScanCode Workbench\"\u003e\n\u003c/p\u003e\n\n[![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)\n[![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)\n\nScanCode Workbench provides an advanced visual UI to help you quickly evaluate\nlicense and other notices identified by\n[ScanCode](https://github.com/aboutcode-org/scancode-toolkit/).\n[ScanCode](https://github.com/aboutcode-org/scancode-toolkit/) detects licenses,\ncopyrights and other interesting information in your code.\n\nScanCode Workbench is based on [Electron](https://www.electronjs.org/) and will\nbe the primary desktop/GUI tool for using nexB’s\n[AboutCode tools](https://github.com/nexB/aboutcode). This app works on Windows,\nmacOS and Linux operating systems.\n\n![ScanCode Workbench](/src/assets/images/workbench_intro.gif)\n\n## Using\n\n- You can\n  [download the latest release](https://github.com/aboutcode-org/scancode-workbench/releases)\n  for your operating system or build it yourself (see below). Once downloaded,\n  you can find `ScanCode-Workbench` under\n  `dist/ScanCode-Workbench-\u003cos\u003e-\u003carch\u003e-\u003cversion\u003e`\n- ScanCode Workbench \u003e= v4 is only compatible with scans from\n  [ScanCode v32.0.0](https://github.com/aboutcode-org/scancode-toolkit/releases)\n  and above which are run with the ScanCode `-i` option. For a list of available\n  ScanCode options see\n  [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)\n\n```bash\nscancode -clipeu \u003cinput\u003e \u003coutput_file\u003e\n```\n\n- We have provided a set of sample scans that you can quickly review in ScanCode\n  Workbench in order to get a sense of its functionality and the types of\n  information captured by a scan. The samples are located at\n  [https://github.com/aboutcode-org/scancode-workbench/tree/develop/samples](https://github.com/aboutcode-org/scancode-workbench/tree/develop/samples).\n- Import a ScanCode JSON file, and see what components are in your software! See\n  the [documentation](https://scancode-workbench.readthedocs.io) for more\n  information on how to use ScanCode Workbench.\n\n[Import a JSON file](https://scancode-workbench.readthedocs.io/en/latest/how-to-guides/load-your-data/import-json.html)\n\n## Running locally\n\nYou'll need [Node.js](https://nodejs.org) (which comes with\n[npm](http://npmjs.com)) installed on your computer in order to build this app.\nFor a list of platform specific requirements, see the Building section of the\n[documentation](https://scancode-workbench.readthedocs.io/en/latest/contribute/building.html).\nThen, from your command line:\n\n```bash\n# Clone this repository\n$ git clone https://github.com/aboutcode-org/scancode-workbench.git\n\n# Go into the repository\n$ cd scancode-workbench\n\n# Install dependencies and run the app\n$ npm install\n\n# Run the app\n$ npm start\n```\n\n## Release Instructions\n\nYou'll need python 3.x to run the build. You can build a `dist` directory\ncontaining executables for your platform\n\nNote: Due to usage of native modules, a build must be done on target platform\nonly.\n\n```bash\n$ npm run publish\n```\n\nYou can find the executible `ScanCode-Workbench-\u003cversion\u003e` inside\n`out/ScanCode-Workbench-\u003cversion\u003e-\u003cos\u003e-\u003carch\u003e` and distributable archive\n(.tar.gz or .zip) in `dist/`\n\n## Testing\n\nRun tests using:\n\n```bash\n$ npm test\n```\n\n## License\n\n- Apache-2.0\n- Multiple licenses (LGPL, MIT, BSD, etc.) for third-party components.\n\nSee the NOTICE file for more details.\n\n## Support\n\nIf you have a question, a suggestion or find a bug, enter an issue.\n\n[![Gitter chat](https://badges.gitter.im/aboutcode-org/gitter.png)](https://matrix.to/#/#aboutcode-org_scancode-workbench:gitter.im)\n\nFor questions and chats, you can join the Gitter channel at\nhttps://matrix.to/#/#aboutcode-org_scancode-workbench:gitter.im\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faboutcode-org%2Fscancode-workbench","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faboutcode-org%2Fscancode-workbench","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faboutcode-org%2Fscancode-workbench/lists"}