Installation¶

This guide will help you install and set up the AI Imaging Agent on your system.

Prerequisites¶

Before installing, ensure you have:

git clone https://github.com/imaging-plaza/ai-agent.git
cd ai-agent

It's recommended to use a virtual environment to isolate dependencies:

Linux/macOSWindows

python -m venv .venv
source .venv/bin/activate

python -m venv .venv
.venv\Scripts\activate

For regular use:

pip install --upgrade pip
pip install -e .

For development (includes test dependencies):

pip install -e ".[dev]"

Verify that the installation was successful:

ai_agent --help

You should see the available commands:

usage: ai_agent [-h] {chat,sync}

AI Agent CLI

positional arguments:
  {chat,sync}  'chat' launches the chat UI; 'sync' runs one catalog refresh.

Now that you have installed the AI Imaging Agent, proceed to:

If you encounter issues with Python version compatibility:

# Check your Python version
python --version

# Use a specific Python version
python3.10 -m venv .venv

If you encounter dependency conflicts:

# Upgrade pip first
pip install --upgrade pip setuptools wheel

# Try installing again
pip install -e .

Some packages may require system libraries:

Ubuntu/DebianmacOSWindows

sudo apt-get update
sudo apt-get install python3-dev build-essential

# Using Homebrew
brew install python@3.10

Ensure you have Microsoft C++ Build Tools installed.

A Dockerfile is available for containerized deployment:

# Build the Docker image
docker build -t ai-agent -f tools/image/Dockerfile .

# Run the container
docker run -p 7860:7860 --env-file .env ai-agent

Note

Make sure to create a .env file with your configuration before running the Docker container.