Step 1 — Prerequisites¶
Before installing anything, sign up for the required services and gather your API keys. This takes 10–15 minutes and avoids stopping mid-install.
Required services¶
1. A download source — debrid, Usenet, or both¶
cli_debrid needs at least one place to get content from:
| Option | What you need | Good for |
|---|---|---|
| Debrid | A debrid account (below) | Huge instant cache of popular torrents |
| Usenet | A Usenet provider + at least one indexer (see 1b) | Fast, reliable downloads with long retention |
| Both | Everything above | Usenet fills gaps in the debrid cache and vice versa |
You can start with one and add the other later.
1a. Debrid service¶
A debrid service is a premium link provider that caches torrents in the cloud. cli_debrid uses it to stream content without downloading locally.
If you're using debrid, you need one of the following:
| Service | Notes |
|---|---|
| Real-Debrid | Most popular, largest cache |
| AllDebrid | Good alternative |
| Premiumize | Also supports Usenet |
| Torbox | Newer, growing cache |
| Debrid-Link | European provider |
Which one?
Real-Debrid has the largest torrent cache and is the most tested with cli_debrid. Start there if you're unsure.
After signing up, locate your API key:
real-debrid.com/apitoken — copy the token shown.
alldebrid.com/apikeys — create a new API key.
premiumize.me/account — find API Key under your profile.
torbox.app/settings — copy your API key.
debrid-link.com/webapp/apikey — generate a key.
Save this key — you will need it during cli_debrid setup.
1b. Usenet¶
To use Usenet you need two things: a provider that serves the files, and an indexer that tells cli_debrid what's available.
| What | Examples | Notes |
|---|---|---|
| Usenet provider (news server) | Frugal Usenet, Newshosting, Eweka, UsenetExpress | Paid account. You'll need the server hostname, port (563 for SSL), username, password and your plan's connection limit. |
| Newznab indexer | NZBGeek, NZBPlanet, DrunkenSlug, DogNZB | Usually a small yearly fee. You'll need the indexer URL and your API key from your account page. |
Nothing is downloaded to your server — cli_mount streams NZB content from your provider through the same mount used for debrid.
Save your provider login and indexer API key.
2. Media server¶
cli_debrid works with Plex, Jellyfin, or Emby. You need one installed and accessible on your network.
| Media server | Notes |
|---|---|
| Plex | Most features supported. Plex Pass not required. |
| Jellyfin | Free and open source. |
| Emby | Supported via Jellyfin-compatible mode. |
File management modes
cli_debrid has two file management modes that affect which media servers are supported:
- Plex mode — uses the Plex API to manage your library. Plex only.
- Symlink mode — creates symlinks on disk. Works with Plex, Jellyfin, and Emby.
You don't need to configure any libraries yet — that happens after the mount is set up. See the integration guides for setup instructions: Plex · Jellyfin
3. TMDB API key¶
TMDB (The Movie Database) is used for metadata, posters, the Discover page, and trending content.
- Create a free account at themoviedb.org
- Go to Settings → API
- Request a developer API key (instant approval)
- Copy the API Key (v3 auth) value
Save this key.
4. TVDB API key¶
TVDB is where cli_debrid looks up shows and movies, and matches episodes. It's required unless you use Trakt instead.
- Create a free account at thetvdb.com
- Go to API Keys under your account: thetvdb.com/dashboard/account/apikey
- Create a new API key
- Copy the key
Save this key.
Optional services¶
These are not required to get started but are recommended once running:
| Service | Purpose |
|---|---|
| Seerr | Request movies/shows via a clean UI — supports Plex and Jellyfin |
| MDBList | Curated media lists (IMDb Top 250, genre lists, etc.) usable as content sources |
| Scrob | Self-hosted watch tracker (a private Trakt/Letterboxd) — its lists and collection can be content sources |
| Bazarr | Automatic subtitle downloading |
Trakt or Scrob¶
Both are optional. Trakt is the hosted service; Scrob is a self-hosted alternative that syncs with Plex, Jellyfin and Emby. Either can feed lists and recommendations into cli_debrid — use whichever you prefer, or both.
Scrob: you only need your Scrob URL (e.g. http://192.168.1.x:7330) and an API key from Settings → Connections → API Key in Scrob.
Trakt: Trakt is optional. It can be used as a content source (watchlist, lists, collection) and as a metadata fallback for TV shows if you haven't configured a TVDB key.
- Create a free account at trakt.tv
- Go to trakt.tv/oauth/applications
- Click New Application
- Fill in:
- Name:
cli_debrid - Redirect URI:
urn:ietf:wg:oauth:2.0:oob
- Name:
- Copy the Client ID and Client Secret
Save both values if you plan to use Trakt.
Summary checklist¶
Before moving on, confirm you have:
- [ ] A download source: debrid account + API key, and/or a Usenet provider login + indexer API key
- [ ] Plex, Jellyfin, or Emby installed
- [ ] TMDB API key
- [ ] TVDB API key (or Trakt instead)