Options | cross-seed

Options | cross-seed
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 > Fallback
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.
danger
DO NOT remove options from the config file, this will cause errors.
Options on the command line
All options on the command line have a long form, which looks like
--long-form-option
. Some more common options have a single-letter
short form as well, which look like
-f
Some options take multiple arguments, which are always separated by spaces:
--variadic-option arg1 arg2 arg3
tip
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
For instructions on creating and editing the config file, use the
getting started guide
. DO NOT
remove options from the config file, this will cause errors.
tip
What should I do after updating my config?
All options
delay
Config File Name
CLI Short Form
CLI Long Form
Format
Config Default
Fallback
delay
-d
--delay
number
(seconds)
30
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.
DISCLAIMER
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
delay
Examples (Config file)
delay
30
torznab
Config File Name
CLI Short Form
CLI Long Form
Format
Config Default
Fallback
torznab
-T
--torznab
string[]
[]
[]
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.
caution
└────────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.
note
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
Config Default
Fallback
sonarr
--sonarr
string[]
[]
[]
NOTICE
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"
NOTICE
If you are using a secure connection (HTTPS) to Sonarr and you are using a certificate signed by a custom authority, make sure that the environment variable
NODE_EXTRA_CA_CERTS
is set and contains the path to a file containing the root certificate of the custom authority.
radarr
Config File Name
CLI Short Form
CLI Long Form
Format
Config Default
Fallback
radarr
--radarr
string[]
[]
[]
NOTICE
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"
NOTICE
If you are using a secure connection (HTTPS) to Radarr and you are using a certificate signed by a custom authority, make sure that the environment variable
NODE_EXTRA_CA_CERTS
is set and contains the path to a file containing the root certificate of the custom authority.
useClientTorrents
Config File Name
CLI Short Form
CLI Long Form
Format
Config Default
Fallback
useClientTorrents
N/A
--use-client-torrents
boolean
true
false
warning
Deluge with Docker can have a desyncing issue with the WebUI daemon after
prolonged uptime with useClientTorrents, if you notice strange behavior you may
need to use
torrentDir
instead.
Query the torrent client APIs to find matches against its contents. This is a
replacement for torrentDir and is generally recommended. This method supports
qBittorrent's
SQLite
mode and all forms of content
layouts/renames/modifications to the torrent in client.
useClientTorrents
Examples (CLI)
cross-seed search --use-client-torrents
cross-seed search --no-use-client-torrents
useClientTorrents
Examples (Config file)
useClientTorrents
true
torrentDir
Config File Name
CLI Short Form
CLI Long Form
Format
Config Default
Fallback
torrentDir
-i