Skip to content

Getting Started

This guide walks you through everything needed to get cli_debrid up and running from scratch — from signing up for the required services to streaming your first file.

Follow the steps in order. Each page ends with a link to the next step.

The setup flow

  • Step 1 — Prerequisites

    Sign up for required services and gather your API keys before installing anything.

    Prerequisites

  • Step 2 — Mount your debrid storage

    Use Zurg or Decypharr to mount your debrid cloud library as a local folder your media server can read.

    Mount setup

  • Step 3 — Install cli_debrid

    Install the app on your platform — Unraid, Docker, TrueNAS, Proxmox, Ubuntu, or Windows.

    Install

  • Step 4 — Configure cli_debrid

    Connect your debrid provider, media server, and mount path. Choose Plex mode or symlink mode.

    Configure

  • Step 5 — Add scrapers

    Set up at least one scraper so cli_debrid can find torrents for your content.

    Scrapers

  • Step 6 — Add content sources

    Tell cli_debrid what to download — Trakt watchlists, Seerr requests, or manual lists.

    Content sources

How it all fits together

flowchart LR
    A["Content Sources\nSeerr, Trakt, Watchlists"] --> B
    B["cli_debrid\nscrapes torrents & manages library"] --> C
    C["Debrid Service\nReal-Debrid / AllDebrid / etc."] --> D
    D["Mount Service\nZurg / Decypharr"] --> E
    E["Media Server\nPlex / Jellyfin / Emby"]
    B -->|"triggers scan"| E

File management modes

flowchart LR
    A["Mount Service\nZurg / Decypharr"] --> B["Plex\nreads files directly from mount"]
    C["cli_debrid"] --> D["Debrid Service"]
    D --> A
    C -->|"triggers library scan via API"| B

Plex reads files directly from the debrid mount. cli_debrid uses the Plex API to trigger scans. Plex only.

flowchart LR
    A["Mount Service\nZurg / Decypharr"] --> B["cli_debrid\ncreates symlinks"]
    B --> C["Symlink path\norganised folder structure"]
    C --> D["Media Server\nPlex / Jellyfin / Emby"]
    E["Debrid Service"] --> A
    B --> E
    B -->|"triggers scan"| D

cli_debrid creates symlinks from the mount into an organised folder. Your media server scans the symlink folder. Works with Plex, Jellyfin, and Emby.

Already have some of this set up?

Jump straight to whichever step you need. Each page is self-contained.