GPT powered CLI tool for renaming TV series files for better recognition by media players such as Plex, Jellyfin, etc.
- Download the latest release from the releases page
- Extract the downloaded file
- Run the executable in the desired directory
-
On Windows:
./tv-series-renaimer.exe -k <API_KEY> [OPTIONS]
-
On Linux:
./tv-series-renaimer -k <API_KEY> [OPTIONS]
-
| Option | Description | Default Value |
|---|---|---|
| -k, --key | REQUIRED: GPT API key (get it from https://platform.openai.com/) | None |
| -p, --path | Path to the directory that will be scanned | "./" |
| -m, --mode | Mode to run the program in (recursive or single) | "recursive" |
| -g, --gtp_model | Model to use, must be one with JSON mode enable (https://platform.openai.com/docs/guides/text-generation/json-mode) | "gpt-4o" |
-
Run the rust code
cargo run -- -k <API_KEY>
-
Run unit tests
cargo test
