Skip to content

Parsec Documentation

Parsec Header

Welcome to the Parsec documentation. Below is an index of all available guides to help you configure, run, and customize Parsec.

Getting Started

  • Installation Guide - Install precompiled binaries, configure system dependencies, or build from source.
  • Configuration and Presets - Learn how to set up your .toml configuration and use presets.
  • Docker Guide - Instructions for running Parsec via Docker (temporary or persistent containers).
  • Shell Completion - Generate autocompletion scripts for your terminal.
  • Update Command - How to perform in-place updates of the Parsec binary.

Core Commands

  • Check Command - Perform comprehensive integrity and consistency checks on media files to ensure they meet your specifications.
  • Identify Command - Search for and identify movies or TV shows using external databases (TMDB, TVDB, IMDb).
  • Rename Command - Automatically rename files using metadata extracted from the file, MediaInfo, and external databases.
  • Autocorrect Command - Automatically repair non-compliant Matroska tracks, order, compression, and flags without re-encoding.
  • Generate NFO - Generate rich XML or text NFO files by querying databases and applying templates.

Advanced Customization & Templating

  • Naming Templates - Guide to Parsec's Go template engine and naming rules for renaming and verifying filenames.
  • Regex Replacements - Define custom regex replacement rules for the input, title, and output stages.
  • Tag Templates - Customize how scraped metadata is translated and written to Matroska MKV tags.
  • NFO Templating System - Learn how to build custom NFO templates using Go's text/template engine.
  • NFO Context Reference - A complete reference guide of all the variables and data fields available for use inside your NFO templates.