stwhite
/
gonamer
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
gonamer/README.md

2.1 KiB
Raw Permalink Blame History

Gonamer

Gonamer is a command-line tool written in Go that uses any openai compatible vision model to intelligently rename image files based on their content. It analyzes images and suggests descriptive, meaningful filenames that reflect what's in the image.

Features

  • Uses any OpenAI compatible vision model to analyze image content
  • Supports JPG, JPEG, PNG, and GIF formats
  • Generates unique, descriptive filenames
  • Handles filename conflicts automatically
  • Sanitizes filenames for cross-platform compatibility
  • Configurable via YAML configuration file

Installation

  1. Ensure you have Go installed on your system
  2. Clone this repository
  3. Install dependencies:
go get gopkg.in/yaml.v3

Configuration

By default, Gonamer looks for a configuration file at ~/.config/gonamer.yaml. You can also specify a custom configuration file using the -c flag.

Create a configuration file with the following structure:

apikey: "your-api-key"
model: "gpt-4-vision-preview"
endpoint: "https://api.openai.com/v1/chat/completions"
temperature: 0.7

Make sure to replace:

  • your-api-key with your API key
  • endpoint with your preferred OpenAI-compatible API endpoint (supports OpenAI, Azure OpenAI, or any compatible API provider)

Usage

gonamer [-c config.yaml] <image_filename>

For example:

# Using default config at ~/.config/gonamer.yaml
gonamer vacation_photo.jpg

# Using a custom config file
gonamer -c custom-config.yaml vacation_photo.jpg

The tool will:

  1. Analyze the image using OpenAI's vision model
  2. Generate a descriptive filename based on the image content
  3. Sanitize the filename for compatibility
  4. Rename the file while preserving the original extension
  5. Handle any filename conflicts by adding a numeric suffix

Error Handling

  • Invalid file extensions will be rejected
  • Network errors will be reported clearly
  • Filename conflicts are resolved automatically
  • Invalid characters in suggested filenames are sanitized

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

This project is open source and available under the MIT License.