Added safety protection to prevent force push to master branch
Indexers
This Repo contains Cardigann YML indexer definitions for Prowlarr.
For more information on the formatting of the YML Indexer Definition, please see our Prowlarr Cardigann YML Version / Definition wiki entry
To develop and test definitions, you may use the Custom Definition Folder
For Prowlarr Indexer Requests; please see our request forum on Discord
Definitions from Jackett
With some differences and a few exceptions Prowlarr Cardigann Indexers are synced upstream with Jackett via the indexer-sync script in this repository. Syncs are automated daily via GitHub Actions, but can also be triggered manually. Any user may also pull request a manual sync.
Sync Jackett Indexers
For detailed instructions on syncing Jackett indexers, including script features, usage examples, and command-line options, see the Contributing Guide.
Definition Versions
Versions require Prowlarr Cardigann C# modifications. Prowlarr will fall back to a previous version if no YML exists for the current version.
Schemas
Each Cardigann Version has a YML Schema for it contained within the definitions's respective folder named schema.json
For more specific details between versions the schema files can be compared.
To test a definition file against a specific schema use the command below.
Python Validation
# Setup (one time)
python -m venv .venv
# Activate virtual environment
# On Linux/Mac:
source .venv/bin/activate
# On Windows:
source .venv/Scripts/activate
pip install -r requirements.txt
# Validate all definitions (supports both Prowlarr versioned and Jackett flat structures)
python scripts/validate.py
# Validate specific directory
python scripts/validate.py /path/to/definitions
# Validate single file against schema
python scripts/validate.py --single "file.yml" "schema.json"
# Show only first error (default shows all errors)
python scripts/validate.py --first-error-only
# Find best schema version for a file
python scripts/validate.py --find-best-version "file.yml"
# Or use convenience script
./scripts/validate-python.sh
The validation script supports:
- Flexible directory structures: Works with Prowlarr's versioned directories (
v10/,v11/) and Jackett's flat structure with rootschema.json - All errors by default: Shows all validation issues at once instead of stopping at the first error
- Concise error messages: Clean output showing only validation type, schema path, and invalid values
- Auto-detection: Automatically detects directory structure and uses appropriate validation method
Active Versions
The repository currently supports indexer definition schemas from v1 through v11. The latest available versions are:
-
V11 Indexers - Dev 1.20.0.4590
- Prowlarr Cardigann v11 includes several changes such as:
- Predefined setting type:
info_category_8000 - Optional
selectorinputsandgetselectorinputsfor login section - Extended language support with duplicated language codes
- Enhanced SelectorBlock validation with dependency rules
- Predefined setting type:
- Prowlarr Cardigann v11 includes several changes such as:
-
V10 Indexers - Dev 1.18.0.4543
- Prowlarr Cardigann v10 includes several changes such as:
- Predefined settings type:
info_cookie,info_flaresolverrandinfo_useragent - Enhanced login validation with conditional requirements
- Extended SelectorBlock functionality with type restrictions
- Predefined settings type:
- Prowlarr Cardigann v10 includes several changes such as:
Deprecated Versions
V1 Indexers - Legacy Beta
- Prowlarr Cardigann v1 are base level standard YML
- No new indexers are to be added to v1 as of 2021-10-13
- No new updates backported to v1 as of 2021-10-17
V2 Indexers - Legacy Beta
- Prowlarr Cardigann v2 includes several changes such as:
- Regex removal for Size parsing
- Multiple Download Selectors
- Optional Selectors
- Testlink Torrents
- InfoHash links
- AllowRawSearch property in caps
- No new indexers are to be added to v2 as of 2022-04-18
- No new updates backported to v2 as of 2022-04-18
V3 Indexers - Legacy Beta
- Prowlarr Cardigann v3 includes support for APIs and JSON
- Replace
imdb:selector withimdbid: - Makes
Descriptionan optional by default - All new Indexers using APIs shall be in v3 as of 2021-10-21
- Indexers utilizing CategoryDescr or any v4 features MUST be in v4
V4 Indexers - Dev 0.2.0.1678
- Prowlarr Cardigann v4 includes several changes such as:
- TMDBId
- Genre
- TraktID
- CategoryDescr
V5 Indexers - Dev 0.2.0.1678
- Prowlarr Cardigann v5 includes several changes such as:
- Allow JSON Filters
V6 Indexers - Dev 0.4.2.1879
- Prowlarr Cardigann v6 includes several changes such as:
doubanidsupporttmdbidTV Search Support
V7 Indexers - Dev 0.4.4.1947
- Prowlarr Cardigann v7 includes several changes such as:
Publisher,Year,Genre, Query support
V8 Indexers - Dev 1.1.0.2322
- Prowlarr Cardigann v8 includes several changes such as:
- HtmlEncode and HtmlDecode filters
V9 Indexers - Dev 1.4.0.3230
- Prowlarr Cardigann v9 includes several changes such as:
- AllowEmptyInputs
- default values
- MissingAttributeEqualsNoResults