aibom

(โ˜… 103)

AI Bill of Materials through source code scanning

  • .dockerignore
  • .gitignore
  • .pre-commit-config.yaml
  • CLAUDE.md
  • CODE_OF_CONDUCT.md
  • CODEOWNERS
  • CONTRIBUTING.md
  • DEVELOPING.md
  • LICENSE
  • README.md
  • SECURITY.md

# Installation Guide

1. Get the code
git clone https://github.com/cisco-ai-defense/aibom

Downloads the entire project code from GitHub to your computer.

cd aibom

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended
curl -LsSf https://astral.sh/uv/install.sh | sh

Downloads and runs the official install script in one line โ€” this handles the full setup automatically.

โœ… After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Docker

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker build -f Dockerfile -t cisco-aibom ..

Builds a runnable image based on the Dockerfile.

docker run --rm -v /path/to/project:/workspace cisco-aibom \

Runs the built image as an actual container.

SCAN_DIR=/path/to/project docker compose run aibom \

Runs the command against the services defined in the compose file.

โœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

Pulled directly from this repo's README.

4. Python

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.
pip install .

Installs the package published on PyPI directly โ€” no need to clone the source.

python <์‹คํ–‰ํ•  ํŒŒ์ผ๋ช…>.py # README์—์„œ ์ •ํ™•ํ•œ ์‹คํ–‰ ํŒŒ์ผ๋ช…์„ ํ™•์ธํ•˜์„ธ์š”

Runs the Python script (or module).

โœ… If it runs without errors and prints output in the terminal, it worked.
// repository documentation