Options
cross-seed
has several program options, which can either be specified on the
command line or in a configuration file. The priority is shown below.
CLI > config file > defaults
If you specify an option both on the command line and in the config file, the command line value will override the config file's value.
Options on the command line
All options on the command line have a long form, which looks like
--long-form-option <value>
. Some more common options have a single-letter
short form as well, which look like -f <value>
.
Some options take multiple arguments, which are always separated by spaces:
--variadic-option arg1 arg2 arg3
Any references to options you see in camelCase
have their corresponding
long-form option name as the kebab-cased
variant. For example, the
excludeRecentSearch
option's long-form CLI option name is
--exclude-recent-search
.
Options in the config file
cross-seed
will look for a configuration file at
- Mac/Linux/Unix:
~/.cross-seed/config.js
- Windows:
AppData\Local\cross-seed\config.js
If you would like to use a custom config directory, you can set the CONFIG_DIR
environment variable.
To create an editable config file, run the following command:
cross-seed gen-config
Add -d
to this command to generate a config for Docker
From there, you can open the config file in your favorite editor and set up your configuration.
The configuration file uses JavaScript syntax, which means:
- Array/multi options must be enclosed in ['brac', 'kets'].
- Strings must be enclosed in "quotation" marks.
- Array elements and options must be separated by commas.
- Windows users will need to use
\\
for paths. (e.g.c:\\torrents
)
Options used in cross-seed search
Options used in cross-seed daemon
All options
delay
*
Config file name | CLI short form | CLI Long form | Format | Default |
---|---|---|---|---|
delay | -d <value> | --delay <value> | number (seconds) | 30 |
When running a search with cross-seed search
or using searchCadence
in
daemon mode, the delay
option lets you set how long you want cross-seed
to
sleep in between searching for each torrent.
If you set it higher, it will smooth out the load on your indexer, however
setting this lower will result in cross-seed
running faster. We don't
recommend setting this lower than 15, as it could garner unwanted attention from
tracker staff.
You need to read your tracker's rules and be aware of their limits.
You and you alone are responsible for following your tracker's rules.
delay
Examples (CLI)
cross-seed search -d 60
cross-seed search --delay 30
cross-seed daemon -d 20
delay
Examples (Config file)
delay: 30,
torznab
*
Config file name | CLI short form | CLI Long form | Format | Default |
---|---|---|---|---|
torznab | -T <urls...> | --torznab <urls...> | string[] | [] (empty list) |
List of Torznab URLs. You can use Jackett, Prowlarr, or indexer built-in Torznab implementations.
This entry MUST be wrapped in []'s and strings inside wrapped with quotes and separated by commas.
http://localhost:9117/p/a/t/h?query=string
└────────host───────┘└─path─┘└───query───┘
The path of each URL should end in /api
.
Finding your Torznab URLs
For Prowlarr and Jackett you can simply copy the RSS URL from the WebUI.
This works because in Torznab, "RSS feeds" are just a search for the first page of unfiltered (no search query) results from the indexer.
torznab
Examples (CLI)
cross-seed search --torznab https://localhost/prowlarr/1/api?apikey=12345
cross-seed search -T http://prowlarr:9696/1/api?apikey=12345 http://prowlarr:9696/2/api?apikey=12345
cross-seed search -T http://jackett:9117/api/v2.0/indexers/oink/results/torznab/api?apikey=12345
torznab
Examples (Config file)
torznab: ["https://localhost/prowlarr/1/api?apikey=12345"],
torznab: [
"http://prowlarr:9696/1/api?apikey=12345",
"http://prowlarr:9696/2/api?apikey=12345"
],
torznab: ["http://jackett:9117/api/v2.0/indexers/oink/results/torznab/api?apikey=12345"],
sonarr
Config file name | CLI short form | CLI Long form | Format | Default |
---|---|---|---|---|
sonarr | --sonarr <url(s)> | string[] | undefined |
Read about the functionality in the v6 Migration Guide
The URL to your Sonarr instance with your ?apikey=
parameter appended to the end.
Finding your Sonarr URL
For Sonarr you can simply append ?apikey=
to the end of
your WebUI base URL with your API key after the =
.
sonarr
Examples (CLI)
cross-seed search --sonarr https://localhost/?apikey=12345
cross-seed search --sonarr https://localhost/?apikey=12345 https://localhost4k/?apikey=12345
sonarr
Examples (Config file)
sonarr: ["https://sonarr/?apikey=12345"],
sonarr: ["http://sonarr:8989/?apikey=12345","http://sonarr4k:8990/?apikey=12345"],
radarr
Config file name | CLI short form | CLI Long form | Format | Default |
---|---|---|---|---|
radarr | --radarr <url(s)> | string[] | undefined |
Read about the functionality in the v6 Migration Guide
The URL to your Radarr instance with your ?apikey=
parameter appended to the end.
Finding your Radarr URL
For Radarr you can simply append ?apikey=
to the end
of your WebUI base URL with your API key after the =
.
radarr
Examples (CLI)
cross-seed search --radarr https://localhost/?apikey=12345
cross-seed search --radarr https://localhost/?apikey=12345 https://localhost4k/?apikey=12345
radarr
Examples (Config file)
radarr: ["https://radarr/?apikey=12345"],
radarr: ["http://radarr:7878/?apikey=12345","https://radarr4k:7879/?apikey=12345"],
torrentDir
*
Config file name | CLI short form | CLI long form | Format | Default |
---|---|---|---|---|
torrentDir | -i <dir> | --torrent-dir <dir> | string |
Point this at a directory containing torrent files. If you don't know where your torrent client stores its files, the table below might help.
If you wish to search only your data, we previously recommended pointing this to
an empty directory. You can now set this to null
if you wish to search only
your dataDirs
.
If you are using qBittorrent 4.6.x, 5.x (or later) and SQLite database
in
Preferences -> Advanced
you will need to switch to fastresume
and restart
qBittorrent for compatibility with cross-seed
. We have no ETA on SQLite
integration currently.
Leave the torrentDir
as /torrents
and use Docker to map your directory to
/torrents
.
Client | Linux | Windows | Mac |
---|---|---|---|
rTorrent | your session directory as configured in .rtorrent.rc | your session directory as configured in .rtorrent.rc | your session directory as configured in .rtorrent.rc |
Deluge | /home/<username>/.config/deluge/state | %APPDATA%\deluge\state | current version of Deluge not officially supported |
Transmission | /home/<username>/.config/transmission/torrents | Unknown (please submit a PR!) | Unknown (please submit a PR!) |
qBittorrent | /home/<username>/.local/share/data/qBittorrent/BT_backup | C:\Users\<username>\AppData\Local\qBittorrent\BT_backup | ~/Library/Application Support/qBittorrent/BT_backup |
torrentDir
Examples (CLI)
cross-seed search --torrent-dir ~/.config/deluge/state
cross-seed search -i ~/.config/transmission/torrents
torrentDir
Examples (Config file)
torrentDir: "/home/<username>/.config/deluge/state",
torrentDir: "C:\\torrents",
It is necessary to insert double-slashes for your paths, as seen in the examples above. Back-slashes are "escape characters" and "\" equates to ""
outputDir
*
Config file name | CLI short form | CLI long form | Format | Default |
---|---|---|---|---|
outputDir | -s <dir> | --output-dir <dir> | string |
cross-seed
will store the torrent files it finds in this directory. If you use
Injection you'll need to make sure that the client has
access to this path also.
Leave the outputDir
as /cross-seeds
and use Docker to map your directory to
/cross-seeds
.
outputDir
Examples (CLI)
cross-seed search -s .
cross-seed search --output-dir /tmp/output
outputDir
Examples (Config file)
outputDir: "/output",
outputDir: "/tmp/output",
outputDir: ".",
It is necessary to insert double-slashes for your paths, as seen in the examples above. Back-slashes are "escape characters" and "\" equates to ""
dataDirs
Config file name | CLI short form | CLI long form | Format | Default |
---|---|---|---|---|
dataDirs | --data-dirs <dirs...> | --data-dirs <dirs...> | string(s) |
cross-seed
will search the paths provided (separated by spaces). If you use
Injection cross-seed
will use the specified linkType
to create a link to the original file in the linkDir during data-based searchs
where it cannot find a associated torrent file.
We do not recommend you include your linkDir
in the dataDirs
option.
You will need to mount the volume for cross-seed
to have access to the data
and linkDir.
dataDirs
Examples (CLI)
cross-seed search --data-dirs /data/torrents/completed
dataDirs
Examples (Config file)
dataDirs: ["/data/torrents/completed"],
dataDirs: ["/data/torrents/completed", "/media/library/movies"],
dataDirs: ["C:\\My Data\\Downloads\\Movies"],
It is necessary to insert double-slashes for your paths, as seen in the examples above. Back-slashes are "escape characters" and "\\" equates to ""
linkCategory
Config file name | CLI short form | CLI long form | Format | Default |
---|---|---|---|---|
linkCategory | --link-category <category> | N/A | string |
cross-seed
will, when performing data-based searches with
injection, use this category for all injected
torrents.
You will need to mount the volume for cross-seed
to have access to the data
and linkDir.
linkCategory
Examples (CLI)
cross-seed search --link-category category
linkCategory
Examples (Config file)
linkCategory: "Category1",
duplicateCategories
Config file name | CLI short form | CLI long form | Format | Default |
---|---|---|---|---|
duplicateCategories | N/A | --duplicate-categories | boolean | false |
cross-seed
will inject using the original category, appending '.cross-seed',
with the same save paths as your normal categories.
This will prevent an Arr from seeing duplicate torrents in Activity, and attempting to import cross-seeds.
Example: if you have a category called "Movies", this will automatically inject cross-seeds to "Movies.cross-seed"
duplicateCategories
Examples (CLI)
cross-seed search --duplicate-categories
duplicateCategories
Examples (Config file)
duplicateCategories: true,
duplicateCategories: false,
linkDir
Config file name | CLI short form | CLI long form | Format | Default |
---|---|---|---|---|
linkDir | --link-dir <dir> | --link-dir <dir> | string |
cross-seed
will link (symlink/hardlink) in the path provided. If you use
Injection cross-seed
will use the specified linkType
to create a link to the original file in the linkDir
during searches where the
original data is accessible (both torrent and data-based matches).
It is best if your linkDir
is not INSIDE of your included
dataDirs
folders. This is to prevent recursive and erroneous
searches of folders used in linking folder structure.
You will need to mount the volume for cross-seed
to have access to the dataDir
and linkDir.
linkDir
Examples (CLI)
cross-seed search --linkDir /data/torrents/xseeds
linkDir
Examples (Config file)
linkDir: "/links",
linkDir: "C:\\links",
It is necessary to insert double-slashes for your paths, as seen in the examples above. Back-slashes are "escape characters" and "\\" equates to ""
linkType
Config file name | CLI short form | CLI long form | Format | Default |
---|---|---|---|---|
linkType | --link-type <type> | --link-type <type> | string |
cross-seed
will link (symlink/hardlink) in the method provided. If you use
Injection cross-seed
will use the specified linkType
to create a link to the original file in the linkDir during data-based searchs
where it cannot find a associated torrent file.
Valid methods for linkType are symlink
and hardlink
.
You will need to mount the volume for cross-seed
to have access to the
dataDirs
and linkDir
.
linkType
Examples (CLI)
cross-seed search --linkType hardlink
linkType
Examples (Config file)
linkType: "hardlink",
linkType: "symlink",
matchMode
Config file name | CLI short form | CLI long form | Format | Default |
---|---|---|---|---|
matchMode | --match-mode <mode> | --match-mode <mode> | safe /risky /partial* | safe |
cross-seed
uses three types of matching algorithms safe
, risky
, and
partial
(only available in version 6).
These algorithms can only be ran if cross-seed
has snatched the torrent files.
The vast majority of candidates get rejected before a snatch has happened by
parsing information from the title.
option | description |
---|---|
safe | the default which matches based on file naming and sizes. |
risky | matches based on file sizes only. |
partial | can be read about in detail here |
For media library searches risky
or partial
is necessary due to the renaming
of files.
matchMode
Examples (CLI)
cross-seed search --match-mode risky
cross-seed search --match-mode safe
matchMode
Examples (Config file)
matchMode: "risky",
matchMode: "safe",
skipRecheck
Config file name | CLI short form | CLI long form | Format | Default |
---|---|---|---|---|
skipRecheck | N/A | --skip-recheck | boolean | false |
Using skipRecheck in conjunction with risky
could result in you downloading
incorrect/missing pieces rather than cross-seeding properly.
Proceed with caution!
Set this to true
to skip rechecking torrents upon injection.
In an upcoming version of v6, torrents will be resumed even with
skipRecheck: false
, if applicable.
skipRecheck
Examples (CLI)
cross-seed search --skip-recheck # will skip rechecking
cross-seed search # will not skip rechecking
skipRecheck
Examples (Config file)
skipRecheck: true,
skipRecheck: false,
includeSingleEpisodes
Config file name | CLI short form | CLI long form | Format | Default |
---|---|---|---|---|
includeSingleEpisodes | N/A | --include-single-episodes | boolean | false |
Behavior of this option has changed in v6, please see the migration guide for details on the implementation's changes'.
Set this to true
to include ALL SINGLE episodes when searching (which are
ignored by default).
This will NOT include episodes present inside season packs (data-based searches).
This option has explicit usage examples given in the config templates which outlines the most common scenarios.
includeSingleEpisodes
Examples (CLI)
cross-seed search --include-single-episodes # will include single episodes not from season pack
cross-seed search # will not include episodes
includeSingleEpisodes
Examples (Config file)
includeSingleEpisodes: true,
includeSingleEpisodes: false,
seasonFromEpisodes
Config file name | CLI short form | CLI long form | Format | Default |
---|---|---|---|---|
seasonFromEpisodes | N/A | --season-from-episodes | number (decimal from 0 to 1) | 1 |
This is an upcoming feature for v6.
cross-seed
will also aggregate individual episodes into season packs for
searching (when applicable) or to match with season packs from rss/announce.
This will only match season packs where you have at least the specified ratio of
episodes. undefined
or null
disables this feature. If enabled, values below
1 requires matchMode partial.
seasonFromEpisodes
Examples (CLI)
cross-seed search --season-from-episodes 0.8 # will also combine episodes into season packs if you have at least 80% of the episodes
cross-seed search # will not join episodes to season packs
seasonFromEpisodes
Examples (Config file)
seasonFromEpisodes: 0.8,
seasonFromEpisodes: undefined,
maxRemainingForResume
Config file name | CLI short form | CLI long form | Format | Default |
---|---|---|---|---|
maxRemainingForResume | N/A | --max-remaining-for-resume | number (0 to 50) | 50 |
This is an upcoming feature for v6.
The amount remaining for an injected torrent in MiB for cross-seed
to resume.
Complete matches will always be resumed.
maxRemainingForResume
Examples (CLI)
cross-seed search --max-remaining-for-resume 0 # only resume complete matches
maxRemainingForResume
Examples (Config file)
maxRemainingForResume: 50,
maxRemainingForResume: 0,
includeNonVideos
Config file name | CLI short form | CLI long form | Format | Default |
---|---|---|---|---|
includeNonVideos | --include-non-videos | boolean | false |
Behavior of this option has changed in v6, please see the migration guide for details on the implementation's changes.
Set this to true
to include torrents that contain a majority of files other
than video files (.mp4
, .avi
, .mkv
) in the search.
includeNonVideos
Examples (CLI)
cross-seed search --include-non-videos # will include non-videos
cross-seed search --no-include-non-videos # will not include non-videos
cross-seed search # will not include non-videos
includeNonVideos
Examples (Config file)
includeNonVideos: true,
includeNonVideos: false,
fuzzySizeThreshold
Config file name | CLI short form | CLI long form | Format | Default |
---|---|---|---|---|
fuzzySizeThreshold | --fuzzy-size-threshold <value> | number (decimal from 0 to 1) | 0.02 |
Increase this number to reject fewer torrents based on size. There is no guarantee that it will increase your match rate.
This option has very limited utility and under normal operation does not need to be modified.
fuzzySizeThreshold
Examples (CLI)
cross-seed search --fuzzy-size-threshold 0.02
cross-seed daemon --fuzzy-size-threshold 0.02
fuzzySizeThreshold
Examples (Config file)
fuzzySizeThreshold: 0.02,
excludeOlder
Config file name | CLI short form | CLI long form | Format | Default |
---|---|---|---|---|
excludeOlder | -x <value> | --exclude-older <value> | string in the ms format |
When running a search, this option excludes anything first searched more than
this long ago. This option is only relevant in search
mode or in daemon
mode
with searchCadence
turned on.
excludeOlder
will never exclude torrents that are completely new to
cross-seed
or torrents seen via RSS or Announce API.
excludeOlder
Examples (CLI)
cross-seed search -x 10h # only search for torrents whose first search was less than 10 hours ago or never
cross-seed search --exclude-older "3 days" # only search for torrents whose first search was less than 3 days ago or never
cross-seed search -x 0s # only search for each torrent once ever
excludeOlder
Examples (Config file)
excludeOlder: "10 hours",
excludeOlder: "3days",
excludeOlder: "0s",
excludeRecentSearch
Config file name | CLI short form | CLI long form | Format | Default |
---|---|---|---|---|
excludeRecentSearch | -r <value> | --exclude-recent-search <value> | string in the ms format |
When running a search, this option excludes anything that has been searched more
recently than this long ago. This option is only relevant in search
mode or in
daemon
mode with searchCadence
turned on.
excludeRecentSearch
will never exclude torrents seen via RSS or Announce API.
Search history is stored on a per-indexer basis.
Searches that failed on specific indexers (for example - due to timeout or rate-limiting) will not be marked as having been searched, and thus will not be excluded by this setting for those specific indexers on the next run.
excludeRecentSearch
Examples (CLI)
cross-seed search -r 1day # only search for torrents that haven't been searched in the past day
cross-seed search --exclude-recent-search "2 weeks" # only search for torrents that haven't been searched in the past 2 weeks
excludeRecentSearch
Examples (Config file)
excludeRecentSearch: "1 day",
excludeRecentSearch: "2 weeks",
action
*
Config file name | CLI short form | CLI long form | Format | Default |
---|---|---|---|---|
action | -A <save/inject> | --action <save/inject> | save /inject | save |
cross-seed
can either save the found cross-seeds, or inject them into your
client. If you use inject
, you will need to set up your client. Read more in
the Injection tutorial.
action
Examples (CLI)
cross-seed search -A inject
cross-seed search --action save
action
Examples (Config file)
action: "save",
action: "inject",
rtorrentRpcUrl
Config file name | CLI short form | CLI long form | Format | Default |
---|---|---|---|---|
rtorrentRpcUrl | --rtorrent-rpc-url <url> | URL |
The url of your rTorrent XMLRPC interface. Only relevant with
Injection. Often ends in /RPC2
.
If you use Sonarr or Radarr, cross-seed
is configured the same way.
ruTorrent installations come with this endpoint configured, but naked
rTorrent does not provide this wrapper. If you don't use ruTorrent,
you'll have to
set up the endpoint yourself
with a webserver.
If you use HTTP Digest Auth on this endpoint (recommended), then you can provide
credentials in the following format:
http://username:password@localhost/rutorrent/RPC2
rtorrentRpcUrl
Examples (CLI)
cross-seed search --rtorrent-rpc-url http://rutorrent/rutorrent/RPC2
cross-seed search --rtorrent-rpc-url http://user:pass@localhost:8080/RPC2
rtorrentRpcUrl
Examples (Config file)
rtorrentRpcUrl: "http://rutorrent/rutorrent/RPC2",
rtorrentRpcUrl: "http://user:pass@localhost:8080/RPC2",
qbittorrentUrl
Config file name | CLI short form | CLI long form | Format | Default |
---|---|---|---|---|
qbittorrentUrl | --qbittorrent-url <url> | URL |
The url of your qBittorrent Web UI. Only relevant with Injection.
qBittorrent doesn't use HTTP Basic/Digest Auth, but you can provide your
qBittorrent credentials at the beginning of the URL like so:
http://username:password@localhost:8080/
qbittorrentUrl
Examples (CLI)
cross-seed search --qbittorrent-url http://qbittorrent:8080/qbittorrent
cross-seed search --qbittorrent-url http://user:pass@localhost:8080
qbittorrentUrl
Examples (Config file)
qbittorrentUrl: "http://qbittorrent:8080/qbittorrent",
qbittorrentUrl: "http://user:pass@localhost:8080",
transmissionRpcUrl
Config file name | CLI short form | CLI long form | Format | Default |
---|---|---|---|---|
transmissionRpcUrl | --transmission-rpc-url <url> | URL |
The url of your Transmission RPC Interface. Only relevant with Injection.
Transmission doesn't use HTTP Basic/Digest Auth, but you can provide your
Transmission credentials at the beginning of the URL like so:
http://username:password@localhost:9091/transmission/rpc
transmissionRpcUrl
Examples (CLI)
cross-seed search --transmission-rpc-url http://transmission:8080/transmission/rpc
cross-seed search --transmission-rpc-url http://user:pass@localhost:8080
transmissionRpcUrl
Examples (Config file)
transmissionRpcUrl: "http://transmission:8080/transmission/rpc",
transmissionRpcUrl: "http://username:password@localhost:9091/transmission/rpc",
delugeRpcUrl
Config file name | CLI short form | CLI long form | Format | Default |
---|---|---|---|---|
delugeRpcUrl | --deluge-rpc-url <url> | URL |
The url of your Deluge JSON-RPC Interface. Only relevant with Injection.
Deluge doesn't use HTTP Basic/Digest Auth, but you can provide your
Deluge password at the beginning of the URL like so:
http://:password@localhost:8112/json
delugeRpcUrl
Examples (CLI)
cross-seed search --deluge-rpc-url http://deluge:8112/json
cross-seed search --deluge-rpc-url http://:pass@localhost:8112/json
delugeRpcUrl
Examples (Config file)
delugeRpcUrl: "http://deluge:8112/json",
delugeRpcUrl: "http://:pass@localhost:8112/json",
notificationWebhookUrl
Config file name | CLI short form | CLI long form | Format | Default |
---|---|---|---|---|
notificationWebhookUrl | --notification-webhook-url <url> | URL |
cross-seed
will send a POST request to this URL with the following payload:
POST notificationWebhookUrl
Content-Type: application/json
{
"title": "string",
"body": "string",
"extra": {
"event": "RESULTS",
"name": "string",
"infoHashes": "string[]",
"trackers": "string[]",
"source": "announce | inject | rss | search | webhook",
"result": "SAVED | INJECTED | FAILURE"
}
}
Currently, cross-seed
only sends the "RESULTS" and "TEST" events. In the
future it may send more. This payload supports both
apprise and
Notifiarr.
notificationWebhookUrl
Examples (CLI)
cross-seed daemon --notification-webhook-url http://apprise:8000/notify
notificationWebhookUrl
Examples (Config file)
notificationWebhookUrl: "http://apprise:8000/notify",
host
Config file name | CLI short form | CLI long form | Format | Default |
---|---|---|---|---|
host | --host <host> | host/ip | 0.0.0.0 |
In Daemon Mode, cross-seed
runs a webserver
listening for a few types of HTTP requests. You can use this option to change
the host to bind to and listen on.
If you are using Docker, you do not need to set this. Leave the option as
undefined
.
host
Examples (CLI)
cross-seed daemon --host 192.168.1.100
host
Examples (Config file)
host: "1.3.3.7",
port
*
Config file name | CLI short form | CLI long form | Format | Default |
---|---|---|---|---|
port | -p <port> | --port <port> | number | 2468 |
In Daemon Mode, cross-seed
runs a webserver
listening for a few types of HTTP requests. You can use this option to change
the port it listens on.
port
Examples (CLI)
cross-seed daemon --port 3000
cross-seed daemon -p 3000
port
Examples (Config file)
port: 3000,
rssCadence
Config file name | CLI short form | CLI long form | Format | Default |
---|---|---|---|---|
rssCadence | --rss-cadence <cadence> | string in the ms format |
In Daemon Mode, with this option enabled,
cross-seed
will run periodic RSS searches on your configured indexers to check
if any new uploads match torrents you already own. Setting this option to
null
, or not specifying it at all, will disable the feature.
There is a minimum cadence of 10 minutes
. We recommend keeping it at a
relatively low number (10-30 mins) because if an indexer has a high frequency of
new uploads, keeping the number low will make sure cross-seed
gets a chance to
see each new upload.
rssCadence
Examples (CLI)
cross-seed daemon --rss-cadence 10min
rssCadence
Examples (Config file)
rssCadence: null, // disable the RSS feature
rssCadence: "10 minutes",
rssCadence: "20min",
searchCadence
Config file name | CLI short form | CLI long form | Format | Default |
---|---|---|---|---|
searchCadence | --search-cadence <cadence> | string in the ms format |
In Daemon Mode, with this option enabled,
cross-seed
will run periodic searches of your torrents (respecting your
includeEpisodes
, includeNonVideos
, excludeOlder
, and excludeRecentSearch
settings).
searchCadence
Examples (CLI)
cross-seed daemon --search-cadence "2 weeks"
cross-seed daemon --search-cadence "2w"
searchCadence
Examples (Config file)
searchCadence: null, // disable the periodic search feature
searchCadence: "2w",
searchCadence: "4 weeks",
apiKey
Config file name | CLI short form | CLI long form | Format | Default |
---|---|---|---|---|
apiKey | --api-key <key> | string | undefined |
apiKey
is disabled in the config file by
default, if you want to specify a key set it to a valid key (24 character min).
To find your generated API key, run the cross-seed api-key
command. The API
key can be included with your requests in either of two ways:
# provide api key as a query param
curl -XPOST localhost:2468/api/webhook?apikey=YOUR_API_KEY --data-urlencode ...
# provide api key as an HTTP header
curl -XPOST localhost:2468/api/webhook -H "X-Api-Key: YOUR_API_KEY" --data-urlencode ...
apiKey
Examples (CLI)
cross-seed daemon --api-key <key> # will require auth on requests
apiKey
Examples (Config file)
apiKey: undefined,
apiKey: "abcdefghijklmn0pqrstuvwxyz",
snatchTimeout
Config file name | CLI short form | CLI long form | Format | Default |
---|---|---|---|---|
snatchTimeout | --snatch-timeout <timeout> | string in the ms format | 30 seconds |
This option applies to any snatch (download) of a .torrent file via Torznab. If a response is not given in the amount of time specified then it will consider the snatch as failed.
snatchTimeout
Examples (CLI)
cross-seed daemon --snatch-timeout "15s"
cross-seed search --snatch-timeout "30s"
snatchTimeout
Examples (Config file)
snatchTimeout: undefined, // disable the snatch timeout (http default)
snatchTimeout: "30s",
snatchTimeout: "15s",
searchTimeout
Config file name | CLI short form | CLI long form | Format | Default |
---|---|---|---|---|
searchTimeout | --search-timeout <timeout> | string in the ms format | 2 minutes |
This option applies to any search via Torznab. If the search response is not given in the amount of time specified then it will consider the search failed.
searchTimeout
Examples (CLI)
cross-seed daemon --search-timeout "20s"
cross-seed search --search-timeout "45s"
searchTimeout
Examples (Config file)
searchTimeout: undefined, // disables searchTimeout (http default)
searchTimeout: "60s",
searchTimeout: "20s",
searchLimit
Config file name | CLI short form | CLI long form | Format | Default |
---|---|---|---|---|
searchLimit | --search-limit <number> | number | undefined |
This option applies to any search Torznab. This option will stop searching after the number of searches meets the number specified.
This will apply to searching in daemon mode (periodic/cadence or when given a path which contains many files) or directly with the search command.
searchLimit
Examples (CLI)
cross-seed daemon --search-limit 50
cross-seed search --search-limit 150
searchLimit
Examples (Config file)
searchLimit: undefined, // disable search count limits
searchLimit: 150,
flatLinking
Config file name | CLI short form | CLI long form | Format | Default |
---|---|---|---|---|
flatLinking | --flat-linking | boolean | false |
qBittorrent users using an external program or script, such as qbit_manage, to
force AutoTMM on torrents (e.g. to apply share limits automatically) will need
to enable flatLinking
or modify your workflow accordingly.
Set this to true
to use the flat-folder style linking previously used in v5.
This option will otherwise link any matches to a tracker-specific folder inside
of linkDir
(if set). This prevents cross seeds from conflicting with each
other.
With flatLinking: false
(default):
linkDir/
TrackerA/
Video.mkv
Video2/
Video2.mkv
TrackerB/
Pack/
Pack.1.mkv
Pack.2.mkv
Video.mkv
With flatLinking: true
:
linkDir/
Video.mkv <--- Both TrackerA and TrackerB cross seeds share the same file
Video2/
Video2.mkv
Pack/
Pack.1.mkv
Pack.2.mkv
flatLinking
Examples (CLI)
cross-seed search --flat-linking
flatLinking
Examples (Config file)
flatLinking: true,
flatLinking: false,
blockList
Config file name | CLI short form | CLI long form | Format | Default |
---|---|---|---|---|
blockList | --block-list <strings> | --block-list <strings> | string(s) |
This feature is currently only partially implemented for v6.
cross-seed
will exclude any of the files/releases from cross-seeding during
the prefiltering done for each search/inject/rss/announce/webhook use.
Currently, this only takes strings that are directly applied to only the torrent
names, folders, and hash. e.g
blockList
Examples (Config file)
blockList: ["badRelease", "-blockedGroup", "595ceca24d075435435313c319c3a5f3bec3965a"],
blockList
Examples (CLI)
cross-seed search --block-list "badRelease" "blockedGroup" "595ceca24d075435435313c319c3a5f3bec3965a"
The full list of upcoming supported prefixes are:
name:
nameRegex:
folder:
folderRegex:
category:
tag:
tracker:
hash:
sizeBelow:
sizeAbove:
The regex (ECMAScript flavor) options are for advanced users only. Do not use
without rigorous testing as cross-seed
is unable to perform any checks. Use at
your own risk.
All options, including the regex, are case-sensitive. name:
can be a substring
of the name of inside the .torrent file. folder:
can be a substring of any
folder in the path for data based searches. All other prefixes must match
exactly. category:
tag:
tracker:
are read from source torrents (labels are
considered tag:
). When blocklisting by tracker:
, if the announce url is
https://user:pass@tracker.example.com:8080/announce/key
, you must use host
"tracker:tracker.example.com:8080"
. The blockList sizes are an integer of the
number of bytes.
blockList
Examples (Config file)
blockList: [
"name:Release.Name",
"name:-excludedGroup",
"name:x265",
"nameRegex:[Rr]elease[.\s][Nn]ame",
"folder:folderName",
"folderRegex:folder\d+",
"category:icycool",
"tag:everybody",
"tracker:tracker.example.com:8080",
"hash:3317e6485454354751555555366a8308c1e92093",
"sizeBelow:12345",
"sizeAbove:98765",
],