Skip to main content

Utility commands

The cross-seed app has several subcommand utilities. Some of these can help you debug your system, or help you find more information to file a bug report.

cross-seed gen-config​

Generate an empty config file in its proper location.

Usage​

cross-seed gen-config

cross-seed clear-cache​

danger

Do not use unless instructed to, this rarely necessary. Please seek support if you believe it's needed.

Clear the cache without causing torrents to be re-snatched and reset the timestamps for excludeOlder and excludeRecentSearch.

Usage​

cross-seed clear-cache

cross-seed clear-client-cache​

When to Use

This is unncessary in most cases. Only use if:

  1. You have changed torrent clients while keeping the exact same host and port.
  2. You have changed the OS that cross-seed runs on.
  3. You have modified the trackers or renamed the files of torrents in your client and you don't want to wait for the daily cleanup job. All other modifications to torrents will be detected immediately by cross-seed.

Clear the cache of the torrents for torrentClients and the cache of the data for dataDirs.

Usage​

cross-seed clear-client-cache

cross-seed update-torrent-cache-trackers​

Update the announce urls for torrents in the torrent cache. This is useful if your passkey has changed or the tracker urls have changed.

Usage​

cross-seed update-torrent-cache-trackers "https://tracker1.example.com/announce/123" "https://tracker2.example.com/announce/abc"
cross-seed update-torrent-cache-trackers "example.com:1234" "example.org"
cross-seed update-torrent-cache-trackers "oldpasskey" "newpasskey"

cross-seed restore​

Use snatched torrents from the torrent_cache to attempt to restore cross seeds. You will need to run cross-seed inject afterwards with dataDirs configured.

This can be helpful if you have lost your torrent client session information but still have the downloaded data.

Usage​

cross-seed restore

cross-seed test-notification​

Send a notification to the configured urls

Read more

Usage​

cross-seed test-notification

cross-seed diff​

See if and why two torrents pass the matching algorithm.

Usage​

cross-seed diff <owned torrent> <candidate torrent>

cross-seed tree​

Check a torrent's file tree from cross-seed's perspective.

Usage​

cross-seed tree file.torrent

cross-seed api-key​

Show the api key.

Usage​

cross-seed api-key

cross-seed reset-api-key​

Reset the api key.

Usage​

cross-seed reset-api-key

cross-seed clear-indexer-failures​

Clears all indexer failures from the database

caution

This should be used sparingly, and never repeatedly (back-to-back) in a short period, to clear failures that are otherwise latent/expired or erroneous in Prowlarr/Jackett due to indexers being down.

Usage​

cross-seed clear-indexer-failures

cross-seed inject​

Injects previously saved, or manually added, torrents from outputDir.

You can alternatively specify an --inject-dir by providing the argument.

In some cases, cross-seed may refuse to inject torrents if their titles are too different to prevent false positives. You can override this by using the --ignore-titles flag. This is not recommended unless you are sure that the failed match is a potential cross seed.

Read more about the injection process including how to use your own .torrent files...

Usage​

cross-seed inject
cross-seed inject --inject-dir /path/to/dir
cross-seed inject --ignore-titles

cross-seed rss​

danger

Do not run this command while the daemon is running. This will create errors with the sqlite database. If you want to trigger a rss scan, use the job api instead.

Runs a manual RSS scan (like rssCadence) and performs your specified action on the trackers in your torznab option.

Read about automating this with "daemon" mode...

Usage​

cross-seed rss
danger

Do not run this command while the daemon is running. This will create errors with the sqlite database. If you want to trigger a search, use the job api instead. This supports overriding the time based exclusions as well.

Runs a manual search (like searchCadence) and performs your specified action on the trackers in your torznab option.

You can optionally override the time based exclusions in your config for this search only.

Read about automating this with "daemon" mode...

Usage​

cross-seed search
cross-seed search --no-exclude-recent-search --no-exclude-older