Skip to content

Quick Start Guide

Get started with MKV Episode Matcher in minutes.

Basic Usage

1. Process a Single Season

mkv-match --show-dir "/path/to/show" --season 1

2. Process All Seasons

mkv-match --show-dir "/path/to/show"

3. Test Run (No Changes)

mkv-match --show-dir "/path/to/show" --dry-run true

4. Download Subtitles

mkv-match --show-dir "/path/to/show" --get-subs true

Directory Structure

MKV Episode Matcher expects your TV shows to be organized as follows:

Show Name/
├── Season 1/
│   ├── episode1.mkv
│   ├── episode2.mkv
├── Season 2/
│   ├── episode1.mkv
│   └── episode2.mkv

Reference Subtitle File Structure

Subtitle files that are not automatically downloaded using the --get-subs flag should be named as follows:

~/.mkv-episode-matcher/cache/data/Show Name/
├── Show Name - S01E01.srt
├── Show Name - S01E02.srt
└── ...

Configuration

The configuration file is automatically generated at ~/.mkv-episode-matcher/config.ini:

[Config]
tmdb_api_key = your_api_key
open_subtitles_api_key = your_opensubs_key
show_dir = /path/to/shows
max_threads = 4

Next Steps