# README

SCANOSS Code Compare

SCANOSS Code Compare is a streamlined desktop application for managing open source findings with a clean, distraction-free interface. It features vim-style navigation (j/k), side-by-side code comparison for both snippet and 100% matches, and robust decision management that persists across scans. Users can quickly filter results, mark components as included/omitted/replaced with single keystrokes, and access their previous decisions in future scans.

Features

🔍 Advanced code scanning and component identification
📊 Detailed dependency analysis and visualization
📝 License compliance checking and management
🔄 Real-time scanning results
⚡ Fast and efficient local processing
🎯 Accurate component matching
🖥️ Cross-platform support

Prerequisites

Go 1.x or higher
Node.js and npm
Wails CLI (go install github.com/wailsapp/wails/v2/cmd/wails@latest)

Installation

GUI Application

Download the latest release for your platform from the releases page
Follow the platform-specific installation instructions:
- macOS Installation Guide
- Windows and Linux guides coming soon

CLI Installation (macOS)

# Option 1: Create a symlink (Recommended)
sudo ln -s "/Applications/SCANOSS Code Compare.app/Contents/MacOS/SCANOSS Code Compare" /usr/local/bin/scanoss-cc

# Option 2: Add to PATH
echo 'export PATH="/Applications/SCANOSS Code Compare.app/Contents/MacOS:$PATH"' >> ~/.zshrc
echo 'alias scanoss-cc="\"/Applications/SCANOSS Code Compare.app/Contents/MacOS/SCANOSS Code Compare\""' >> ~/.zshrc
source ~/.zshrc

Usage

CLI Parameters

Parameter	Description	Default Value
scan-root	Scanned folder	$WORKDIR
input	Path to results.json file of the scanned project	$WORKDIR/.scanoss/results.json
config	Path to configuration file	$HOME/.scanoss/scanoss-cc-settings.json
apiUrl	SCANOSS API URL	https://api.osskb.org
key	SCANOSS API Key token (not required for default OSSKB URL)	-
debug	Enable debug mode	false

Example Commands

# Open the GUI application
scanoss-cc

# Open the GUI application with custom parameters (you can also change these from the GUI)
scanoss-cc --scan-root /path/to/scanned/project --input /path/to/results.json

# Basic scan with default settings
scanoss-cc scan /path/to/project

# Scan with custom results path
scanoss-cc scan --input /path/to/results.json

# Scan current directory with multiple parameters
scanoss-cc scan . --key $SCANOSS_API_KEY --apiurl $SCANOSS_API_URL --debug

Development

Setting Up the Development Environment

Clone the repository:

git clone https://github.com/scanoss/scanoss.cc.git
cd scanoss.cc

Run in development mode:

make run

Development with Custom Parameters

# Using make command
make run APPARGS="--scan-root <scanRootPath> --input <resultPath>"

# Using wails command
wails dev -appargs "--input <resultPath>"

Building

# Build for the current platform
make build

Known Issues

Ubuntu 24.04 WebKit Issue

Ubuntu 24.04 includes webkit 4.1 while Wails expects webkit 4.0. To resolve:

For production:

sudo ln -sf /usr/lib/x86_64-linux-gnu/libwebkit2gtk-4.1.so.0 /usr/lib/x86_64-linux-gnu/libwebkit2gtk-4.0.so.37 &&
sudo ln -sf /usr/lib/x86_64-linux-gnu/libjavascriptcoregtk-4.1.so.0 /usr/lib/x86_64-linux-gnu/libjavascriptcoregtk-4.0.so.18

For development: