hunch 2.0.2

A media filename parser for movies, TV, and anime — built in Rust, inspired by guessit
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76

# 🔍 Hunch

[![CI](https://img.shields.io/github/actions/workflow/status/lijunzh/hunch/ci.yml?branch=main&label=CI&logo=github)](https://github.com/lijunzh/hunch/actions/workflows/ci.yml)
[![Crates.io](https://img.shields.io/crates/v/hunch.svg)](https://crates.io/crates/hunch)
[![Docs](https://img.shields.io/docsrs/hunch)](https://docs.rs/hunch)
[![License](https://img.shields.io/crates/l/hunch.svg)](LICENSE)

**A fast, offline media filename parser for Rust — extract title, year,
season, episode, codec, language, and 49 properties from messy filenames.**

A Rust rewrite of Python's [guessit](https://github.com/guessit-io/guessit).
Pure, deterministic, single-binary, linear-time regex only (ReDoS-immune).

## Quick Start

```bash
brew install lijunzh/hunch/hunch   # macOS/Linux
cargo install hunch                 # from source
cargo binstall hunch                # pre-built binary
```

### CLI

```bash
$ hunch "The.Walking.Dead.S05E03.720p.BluRay.x264-DEMAND.mkv"
{
  "container": "mkv",
  "episode": 3,
  "release_group": "DEMAND",
  "screen_size": "720p",
  "season": 5,
  "source": "Blu-ray",
  "title": "The Walking Dead",
  "type": "episode",
  "video_codec": "H.264"
}
```

For batch parsing across a media library and cross-file context for
ambiguous CJK / anime filenames, see the
[User Manual](https://lijunzh.github.io/hunch/user-guide/user-manual.html).

### Library

```rust
use hunch::hunch;

let result = hunch("The.Walking.Dead.S05E03.720p.BluRay.x264-DEMAND.mkv");
assert_eq!(result.title(), Some("The Walking Dead"));
assert_eq!(result.season(), Some(5));
assert_eq!(result.episode(), Some(3));
```

## Documentation

📖 **Full documentation site:** <https://lijunzh.github.io/hunch>

| Document | What's there |
|---|---|
| [**User Manual**](https://lijunzh.github.io/hunch/user-guide/user-manual.html) | Install, CLI, library API, all 49 properties, batch parsing, cross-file context |
| [**guessit Compatibility**](https://lijunzh.github.io/hunch/user-guide/compatibility.html) | Pass rates per property, methodology |
| [**Known Limitations**](https://lijunzh.github.io/hunch/user-guide/known-limitations.html) | Edge cases that remain difficult to handle |
| [**Migrating to v2.0.0**](https://lijunzh.github.io/hunch/about/migration-v2.html) | Breaking-change guide |
| [**Design**](https://lijunzh.github.io/hunch/about/design.html) | Principles, architecture, key decisions |
| [**API Reference**](https://docs.rs/hunch) | Full Rust API docs |
| [**Changelog**](CHANGELOG.md) | Version history |

## Accuracy

Validated against guessit's upstream test suite — see the
[compatibility report](https://lijunzh.github.io/hunch/user-guide/compatibility.html)
for the live pass rate, regenerated from
`cargo test -- --ignored guessit_compat` so it can't drift. Edge cases
that remain difficult are documented under
[Known Limitations](https://lijunzh.github.io/hunch/user-guide/known-limitations.html).