/gopt-renamer

rename your images, screenshots and photos with AI

Primary LanguageGoMIT LicenseMIT

gopt-renamer


Logo

gopt-renamer

A Golang command-line application that auto-renames images based on content by sending to a GPT-vision API.

Watch as gopt-renamer quickly renames screenshots


Explore the docs »
· Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

About The Project

gopt-renamer is a tool that leverages the power of GPT-vision API to automatically generate descriptive and informative file names for images. It is designed to streamline the process of organizing and searching for images by providing meaningful names that reflect the content of the images.

Built With

Installation

Download a release package for your platform of choice from the releases.

Linux Installation

sudo dpkg -i gopt-renamer-ubuntu-latest.deb

Mac Installation

Click the .pkg file and follow the onscreen prompts

Windows Installation

Click the .exe file and follow the onscreen prompts

Getting Started to build manually

To get a local copy up and running follow these simple steps.

Prerequisites

  • Golang installed on your machine. You can download it from here.

Build Installation

  1. Clone the repo
git clone https://github.com/robin-collins/gopt-renamer.git
  1. Build the project
go build

Usage

To use gopt-renamer, simply provide the path to the image file you wish to rename:

./gopt-renamer --image="path/to/image.jpg"

For more examples, please refer to the Documentation

(back to top)

Roadmap

  • Functional Windows, Ubuntu and Mac builds
  • Ollama (llava and baklavva) tested and found to be not suitable.
  • OpenAI API Key saves to either environment variable OR .conf file
  • Create Docs and configure deployment
  • CI/CD ready for release
  • Configurable API endpoint URL via system environment
  • Better Error Handling
  • Windows Installer
  • Mac package
  • Ubuntu package
  • Support Ubuntu and Mac context menu / gui integration

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)

Contact

Robin Collins - @robin_collins - robin.f.collins+gopt@Outlook.com

Project Link: https://github.com/robin-collins/gopt-renamer

(back to top)

Acknowledgments

(back to top)