Overview

pkg/scanoss is the Go SDK behind SCANOSS-CLI: the same scan and decoration services, fingerprinting, file filtering, and SBOM read/write, available as a library for your own Go programs.

Prerequisites

Before you begin, ensure you have:

Go 1.25 or higher

Installation

go get github.com/scanoss/scanoss.go/pkg/scanoss

Quick Start

To scan a folder using all the SCANOSS defaults:

package main

import (
	"context"
	"fmt"
	"os"

	"github.com/scanoss/scanoss.go/pkg/scanoss"
)

func main() {
	client, err := scanoss.New(scanoss.Config{
		APIKey: os.Getenv("SCANOSS_API_KEY"),
	})
	if err != nil {
		panic(err)
	}

	result, err := client.Scan.Folder(context.Background(), "./my-project")
	if err != nil {
		panic(err)
	}

	fmt.Println(result)
}

See Authentication for API key and custom-endpoint options, and Usage for the decoration pipeline, per-service progress reporting, and logging.

Documentation

Links

Prerequisites

Installation

Quick Start

​Prerequisites

​Installation

​Quick Start

Prerequisites

Installation

Quick Start