Installation

ON THIS PAGE

A quick guide to installing AI Image Renamer either within a virtual environment or system-wide (recommended).

Content:

• System Requirements
• Install in Virtual Environment
• Install System-Wide

System Requirements

1. Python 3.8 or higher
2. pip (comes with Python) or pipx

Install in Virtual Environment

If you don't have a virtual environment installed, create one by running the following command in the directory of your project:

python -m venv venv

After that, switch into the virtual environment:

source venv/bin/activate

You can now use pip to install AI Image Renamer from PyPi.org:

pip install ai-image-renamer

Install System-Wide

Use pipx to install AI Image Renamer system-wide so you can use it as a regular CLI tool. Follow the installation instructions of pipx for your operating system.

Once the pipx command is available, install it with the following command:

pipx install ai-image-renamer

That's it! 🥳 You can now use the rename-images command. See "Quick Start" to learn how to use it.