> ## Documentation Index
> Fetch the complete documentation index at: https://docs.scanoss.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Installation

> Get started with AI Finder. Install the CLI and start detecting AI artifacts, models and dependencies across your repositories.

## Prerequisites

Before you begin, make sure you have:

* [Python 3.9 or higher](https://www.python.org/)

## Installation

Install `ai-finder` from [PyPI](https://pypi.org/project/ai-finder/):

```bash theme={null}
# 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:

```bash theme={null}
ai-finder --version
```

## Quick Start

```bash theme={null}
# 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
```