Skip to main content

​
Prerequisites

Before you begin, make sure you have:

​
Installation

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