Installation

Prerequisites

Before you begin, make sure you have:

Python 3.9 or higher

Install ai-finder from PyPI:

# Install from PyPI
pip install ai-finder

# Upgrade an existing installation
pip install --upgrade ai-finder

You can verify that AI Finder is installed correctly by running:

ai-finder --version

Quick Start

# Scan a directory
ai-finder scan /path/to/project

# Generate a CycloneDX SBOM
ai-finder scan /path/to/project -f cyclonedx -o sbom.json

# Generate an SPDX SBOM
ai-finder scan /path/to/project -f spdx -o sbom.spdx.json

# Identify a model file
ai-finder identify model.gguf

# Initialise local knowledge base
ai-finder kb init

# Lookup a model by PURL
ai-finder kb lookup pkg:huggingface/TinyLlama/TinyLlama-1.1B-Chat-v1.0

Ambiguous model hashes are disclosed, not hidden. A base model and its quantization can share the same content hash, so identify may match more than one repository. AI Finder asserts the earliest-registered repository as the answer, and lists the rest as candidate_models in JSON output. Generated SBOMs carry the same disclosure: a candidate_purls property on CycloneDX 1.6, a comment on SPDX 2.3, and an ai-finder:model:candidate_purls comment on SPDX 3.0. An unambiguous match emits nothing extra.

Documentation

Links

Installation

Prerequisites

Installation

Quick Start

​Prerequisites

​Installation

​Quick Start

Prerequisites

Installation

Quick Start