Skip to content

docs: list supported file formats in README #17

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
marksverdhei merged 2 commits into from
Jun 26, 2026
Merged

docs: list supported file formats in README #17

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c0f4a59
docs: list supported file formats in README
marksverdhei Mar 19, 2026
7dc5256
docs: correct Supported Formats — audio IS supported; 4000 chars not 4KB
Jun 26, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,19 @@ Works with any OpenAI-compatible API: local servers (llama.cpp, Ollama, vLLM, LM
- Interactive rename with confirmation
- Robust extension handling: isolates name stem from extension for reliable results with smaller models

## Supported Formats

| Format | How it works |
|--------|-------------|
| **Text files** (.txt, .md, .py, .json, .csv, .xml, .html, etc.) | First 4000 characters of content sent to the LLM |
| **Images** (JPEG, PNG, SVG) | Base64-encoded and sent via the multimodal API |
| **Images** (WebP, BMP, TIFF, GIF) | Converted to PNG via Pillow, then sent as above |
| **Audio** (MP3, FLAC, OGG, AAC, WAV, M4A, Opus, WMA, AIFF, APE) | Not sent to the LLM directly — named from embedded tags (title/artist/album/genre/date + duration) read via `ffprobe` |

Video and other binary files are not supported.

Image naming requires a vision-capable model (e.g. `llava`). Audio naming requires `ffprobe` (from FFmpeg) for tag extraction; images additionally include any EXIF metadata in the prompt.

## Requirements

- Bash 4+
Expand Down
Loading