ai-image-renamer 1.1.0

Rename images based on AI-generated descriptions.

AI Image Renamer

AI Image Renamer CLI is a command-line tool that leverages generative artificial intelligence to intelligently rename your image files based on their content. This helps in organizing your photo collection by giving images more descriptive and searchable filenames. A free Groq API key is required for this project. For a full documentation of this tool, please visit the official documentation.

Features

• 🤖 AI: Leverage the latest AI technology to quickly rename your images
• ⚡️Speed: Groq's fast infrastructure processes your files in milliseconds
• 🔎 SEO: Generated file names are SEO-friendly
• 📚 Batch: Use one or multiple image files within a single command
• 👨‍💻 Easy: Renaming files requires only a single command line

Installation

AI Image Renamer is available through multiple installation methods:

1. Using pipx (recommended)

pipx install ai-image-renamer

2. Using pip

pip install ai-image-renamer

3. From the Git repository

git clone https://gitlab.com/thaikolja/ai-image-renamer.git
cd ai-image-renamer
pip install -e .

4. From a ZIP archive

1. Download the ZIP from the repository.
2. Extract it and run:

cd ai-image-renamer-main
pip install .

5. Run directly from source

python -m ai_image_renamer.cli path/to/image.jpg

After installation, obtain a free Groq API key and set it as an environment variable:

export GROQ_API_KEY="your-key-here"

Usage

The rename-images command is your entry point to the tool. However, since it's using Groq and Meta's Llama 4 Scout model, some limitations apply:

Basic Usage

To rename a single image:

rename-images path/to/your/image.jpg

To rename multiple images:

rename-images image1.png image2.jpg path/to/another/image.webp

To rename an image with only 3 words:

rename-images -w 3 DSC_123.jpg

See rename-images -h for more options, or read the documentation.

Contributing

I welcome contributions to AI Image Renamer! Please see the CONTRIBUTING.md file for guidelines on how to contribute.

Author

1. Kolja Nolte ([e-mail])

License

This project is licensed under the MIT License. See the LICENSE file for details.