profilarr-trash-guides/README.md
2025-07-27 17:42:20 +03:00

1.3 KiB

Unofficial TRaSH-Guides Database Repository

This repository hosts TRaSH-Guides's unofficial database for Profilarr containing:

  • Regex Patterns
  • Custom Formats
  • Quality Profiles

The goal of this repository is to generate a Profilarr database based on TRaSH-Guides configuration without any changes. If you want anything custom you can commit it yourself within the Profilarr UI.

The repo will be automatically kept in sync with the TRaSH-Guides repository with a potential for updates on a daily basis.

Scripts

The repository a script to generate the specification based on the TRaSH-Guide data.

Requirements

The scripts utilize UV for easy package management, ensure it's installed by following the official instructions.

Additionally it's expected that you have a local folder with a TRaSH-Guides clone containing the JSON data (docs/json within the TRaSH-Guides repository). The script does not pull any data.

Running the script

Assuming you're in the root directory of the repository you can now run:

uv run scripts/generate.py /path/to/trash-guides/docs/json .

It will clear any potentially pre-existing output and generate new output based on the provided TRaSH-Guides folder.