Documentation

Everything you need to get started with Renaym

Getting Started Installation Usage Features Configuration Troubleshooting

🚀

Getting Started

Renaym is a single-file desktop app that intelligently renames your movie and TV show files using AI-powered parsing and TMDB metadata. Download, run, and you're ready to go.

Before You Start

✓Get a free TMDB API Key — Sign up at themoviedb.org (takes 2 minutes)⚠️ Use the API Key (v3 auth), not the "API Read Access Token"

💡 The Setup Wizard will prompt you for this key on first launch.

📦

Installation

Download

Download Renaym for your platform from the download page — choose the Installer (recommended) or Portable version

Install or Extract

Run the installer, or extract the portable zip to any folder

Run

Launch Renaym — the Setup Wizard will guide you through first-time configuration

Platform-Specific Installation GuideDetailed

Step-by-step instructions for Windows, macOS, and Linux with security tips

Setup Wizard (First Run)

On first launch, the Setup Wizard will walk you through:

1Download AI Model — One-time download (~2.3 GB) for intelligent filename parsing
2Enter TMDB API Key — Required for movie/TV metadata lookups

That's it! Once setup is complete, you're ready to start renaming files.

🎯

Basic Usage

📁Step 1

Select Folder

Click 'Select Folder' or drag & drop files into the application

🔍Step 2

Scan & Match

Click 'Scan & Match' to automatically match files with TMDB

👁️Step 3

Review

Check the proposed renames and adjust if needed

✏️Step 4

Execute

Click 'Execute Rename' to rename your files

↩️Pro tip: Use "Undo Last" if you need to revert any changes

⭐

Features

🤖

AI-Powered Parsing

Local LLM intelligently extracts metadata from even the messiest filenames

🎬

TMDB Integration

Accurate metadata matching with intelligent scoring from The Movie Database

📝

Subtitle Support

Automatically pairs and renames .srt, .sub, .ass, .ssa, .vtt files

🛡️

Safe Operations

Collision detection prevents overwrites, with full undo support

🎨

Custom Templates

Customize naming patterns to match your preferred organization style

💾

Smart Caching

Caches TMDB responses for faster subsequent operations

⚙️

Configuration

Settings are managed through the Settings panel in the application. You can configure:

// Available settings

TMDB API Key — Required for metadata lookup

LLM Model Path — Optional, for AI parsing

Movie Template — e.g., "{Title} ({Year})"

TV Template — e.g., "{Title} S{Season}E{Episode}"

Cache Settings — Configure caching behavior

🔧

Troubleshooting

❓No matches found?

Try adjusting the filename to be clearer, or search manually in TMDB. Sometimes files with unusual naming conventions need manual intervention.

❓AI parsing not working?

Make sure you completed the AI model download during setup. If skipped, the app will use regex-based parsing instead. You can re-run the setup from Settings.

❓TMDB lookups failing?

Verify your TMDB API key is correct in Settings. Make sure you're using the API Key (v3 auth), not the 'API Read Access Token'.

❓App won't start?

Try extracting to a different folder. On Windows, avoid protected folders like Program Files unless using the installer.

Need Help?

Choose the best path for bugs, questions, or feature ideas.